New upstream version 1.4.64
This commit is contained in:
TANIGUCHI Takaki
parent
af927425f0
commit
f90a4166da
2
PKG-INFO
2
PKG-INFO
|
|
@ -1,6 +1,6 @@
|
|||
Metadata-Version: 1.1
|
||||
Name: botocore
|
||||
Version: 1.4.60
|
||||
Version: 1.4.64
|
||||
Summary: Low-level, data-driven core of boto 3.
|
||||
Home-page: https://github.com/boto/botocore
|
||||
Author: Amazon Web Services
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
Metadata-Version: 1.1
|
||||
Name: botocore
|
||||
Version: 1.4.60
|
||||
Version: 1.4.64
|
||||
Summary: Low-level, data-driven core of boto 3.
|
||||
Home-page: https://github.com/boto/botocore
|
||||
Author: Amazon Web Services
|
||||
|
|
|
|||
|
|
@ -83,6 +83,9 @@ 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/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
|
||||
|
|
@ -408,6 +411,7 @@ 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_cloudsearchdomain.py
|
||||
tests/functional/test_credentials.py
|
||||
tests/functional/test_iot_data.py
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ import os
|
|||
import re
|
||||
import logging
|
||||
|
||||
__version__ = '1.4.60'
|
||||
__version__ = '1.4.64'
|
||||
|
||||
|
||||
class NullHandler(logging.Handler):
|
||||
|
|
|
|||
|
|
@ -20,7 +20,6 @@ import copy
|
|||
import logging
|
||||
|
||||
import botocore.serialize
|
||||
from botocore.utils import fix_s3_host
|
||||
from botocore.signers import RequestSigner
|
||||
from botocore.config import Config
|
||||
from botocore.endpoint import EndpointCreator
|
||||
|
|
@ -50,6 +49,7 @@ class ClientArgsCreator(object):
|
|||
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(
|
||||
|
|
@ -58,10 +58,7 @@ class ClientArgsCreator(object):
|
|||
endpoint_config['signature_version'],
|
||||
credentials, event_emitter)
|
||||
|
||||
# Add any additional s3 configuration for client
|
||||
config_kwargs['s3'] = s3_config
|
||||
self._conditionally_unregister_fix_s3_host(endpoint_url, event_emitter)
|
||||
|
||||
new_config = Config(**config_kwargs)
|
||||
endpoint_creator = EndpointCreator(event_emitter)
|
||||
|
||||
|
|
@ -83,7 +80,8 @@ class ClientArgsCreator(object):
|
|||
'request_signer': signer,
|
||||
'service_model': service_model,
|
||||
'loader': self._loader,
|
||||
'client_config': new_config
|
||||
'client_config': new_config,
|
||||
'partition': partition
|
||||
}
|
||||
|
||||
def compute_client_args(self, service_model, client_config,
|
||||
|
|
@ -175,11 +173,6 @@ class ClientArgsCreator(object):
|
|||
|
||||
return s3_configuration
|
||||
|
||||
def _conditionally_unregister_fix_s3_host(self, endpoint_url, emitter):
|
||||
# If the user is providing a custom endpoint, we should not alter it.
|
||||
if endpoint_url is not None:
|
||||
emitter.unregister('before-sign.s3', fix_s3_host)
|
||||
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -25,13 +25,14 @@ 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 fix_s3_host
|
||||
from botocore.utils import get_service_module_name
|
||||
from botocore.utils import switch_to_virtual_host_style
|
||||
from botocore.utils import switch_host_s3_accelerate
|
||||
from botocore.utils import S3_ACCELERATE_ENDPOINT
|
||||
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
|
||||
|
|
@ -67,7 +68,7 @@ class ClientCreator(object):
|
|||
service_model, region_name, is_secure, endpoint_url,
|
||||
verify, credentials, scoped_config, client_config, endpoint_bridge)
|
||||
service_client = cls(**client_args)
|
||||
self._create_s3_redirector(service_client, endpoint_bridge)
|
||||
self._register_s3_events(service_client, endpoint_bridge, endpoint_url)
|
||||
return service_client
|
||||
|
||||
def create_client_class(self, service_name, api_version=None):
|
||||
|
|
@ -114,10 +115,101 @@ class ClientCreator(object):
|
|||
self._event_emitter.register('needs-retry.%s' % endpoint_prefix,
|
||||
handler, unique_id=unique_id)
|
||||
|
||||
def _create_s3_redirector(self, client, endpoint_bridge):
|
||||
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,
|
||||
|
|
@ -387,7 +479,7 @@ class BaseClient(object):
|
|||
|
||||
def __init__(self, serializer, endpoint, response_parser,
|
||||
event_emitter, request_signer, service_model, loader,
|
||||
client_config):
|
||||
client_config, partition):
|
||||
self._serializer = serializer
|
||||
self._endpoint = endpoint
|
||||
self._response_parser = response_parser
|
||||
|
|
@ -397,7 +489,7 @@ class BaseClient(object):
|
|||
self._client_config = client_config
|
||||
self.meta = ClientMeta(event_emitter, self._client_config,
|
||||
endpoint.host, service_model,
|
||||
self._PY_TO_OP_NAME)
|
||||
self._PY_TO_OP_NAME, partition)
|
||||
self._register_handlers()
|
||||
|
||||
def _register_handlers(self):
|
||||
|
|
@ -406,55 +498,6 @@ class BaseClient(object):
|
|||
self.meta.service_model.endpoint_prefix,
|
||||
self._request_signer.handler)
|
||||
|
||||
self._register_s3_specific_handlers()
|
||||
|
||||
def _register_s3_specific_handlers(self):
|
||||
# Register all of the s3 specific handlers
|
||||
if self.meta.config.s3 is None:
|
||||
s3_addressing_style = None
|
||||
s3_accelerate = None
|
||||
s3_dualstack = None
|
||||
else:
|
||||
s3_addressing_style = self.meta.config.s3.get('addressing_style')
|
||||
s3_accelerate = self.meta.config.s3.get('use_accelerate_endpoint')
|
||||
s3_dualstack = self.meta.config.s3.get('use_dualstack_endpoint')
|
||||
|
||||
# Enable accelerate if the configuration is set to to true or the
|
||||
# endpoint being used matches one of the Accelerate endpoints.
|
||||
if s3_accelerate or S3_ACCELERATE_ENDPOINT in self._endpoint.host:
|
||||
# Amazon S3 accelerate is being used then always use the virtual
|
||||
# style of addressing because it is required.
|
||||
self._force_virtual_style_s3_addressing()
|
||||
# Also make sure that the hostname gets switched to
|
||||
# s3-accelerate.amazonaws.com
|
||||
self.meta.events.register_first(
|
||||
'request-created.s3', switch_host_s3_accelerate)
|
||||
elif s3_addressing_style:
|
||||
# Otherwise go ahead with the style the user may have specified.
|
||||
if s3_addressing_style == 'path':
|
||||
self._force_path_style_s3_addressing()
|
||||
elif s3_addressing_style == 'virtual':
|
||||
self._force_virtual_style_s3_addressing()
|
||||
elif s3_dualstack:
|
||||
self.meta.events.unregister('before-sign.s3', fix_s3_host)
|
||||
self.meta.events.register(
|
||||
'before-sign.s3',
|
||||
functools.partial(fix_s3_host, default_endpoint_url=None))
|
||||
|
||||
def _force_path_style_s3_addressing(self):
|
||||
# Do not try to modify the host if path is specified. The
|
||||
# ``fix_s3_host`` usually switches the addresing style to virtual.
|
||||
self.meta.events.unregister('before-sign.s3', fix_s3_host)
|
||||
|
||||
def _force_virtual_style_s3_addressing(self):
|
||||
# If the virtual host addressing style is being forced,
|
||||
# switch the default fix_s3_host handler for the more general
|
||||
# switch_to_virtual_host_style handler that does not have opt out
|
||||
# cases (other than throwing an error if the name is DNS incompatible)
|
||||
self.meta.events.unregister('before-sign.s3', fix_s3_host)
|
||||
self.meta.events.register(
|
||||
'before-sign.s3', switch_to_virtual_host_style)
|
||||
|
||||
@property
|
||||
def _service_model(self):
|
||||
return self.meta.service_model
|
||||
|
|
@ -660,12 +703,13 @@ class ClientMeta(object):
|
|||
"""
|
||||
|
||||
def __init__(self, events, client_config, endpoint_url, service_model,
|
||||
method_to_api_mapping):
|
||||
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):
|
||||
|
|
@ -686,3 +730,7 @@ class ClientMeta(object):
|
|||
@property
|
||||
def method_to_api_mapping(self):
|
||||
return self._method_to_api_mapping
|
||||
|
||||
@property
|
||||
def partition(self):
|
||||
return self._partition
|
||||
|
|
|
|||
|
|
@ -69,6 +69,20 @@
|
|||
],
|
||||
"documentation":"<p>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.</p> <note> <p>Currently, ACM Certificates can be used only with Elastic Load Balancing and Amazon CloudFront.</p> </note>"
|
||||
},
|
||||
"ImportCertificate":{
|
||||
"name":"ImportCertificate",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ImportCertificateRequest"},
|
||||
"output":{"shape":"ImportCertificateResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p>Imports an SSL/TLS certificate into AWS Certificate Manager (ACM) to use with <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-services.html\">ACM's integrated AWS services</a>.</p> <note> <p>ACM does not provide <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html\">managed renewal</a> for certificates that you import.</p> </note> <p>For more information about importing certificates into ACM, including the differences between certificates that you import and those that ACM provides, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>.</p> <p>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.</p> <p>The certificate, private key, and certificate chain must be PEM-encoded. For more information about converting these items to PEM format, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html#import-certificate-troubleshooting\">Importing Certificates Troubleshooting</a> in the <i>AWS Certificate Manager User Guide</i>.</p> <p>To import a new certificate, omit the <code>CertificateArn</code> field. Include this field only when you want to replace a previously imported certificate.</p> <p>This operation returns the <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>"
|
||||
},
|
||||
"ListCertificates":{
|
||||
"name":"ListCertificates",
|
||||
"http":{
|
||||
|
|
@ -119,7 +133,7 @@
|
|||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidDomainValidationOptionsException"}
|
||||
],
|
||||
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/overview.html\">AWS Certificate Manager User Guide </a>.</p>"
|
||||
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/\">AWS Certificate Manager User Guide</a>.</p>"
|
||||
},
|
||||
"ResendValidationEmail":{
|
||||
"name":"ResendValidationEmail",
|
||||
|
|
@ -163,34 +177,44 @@
|
|||
},
|
||||
"CertificateBody":{
|
||||
"type":"string",
|
||||
"max":524288,
|
||||
"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":"<p>The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>"
|
||||
},
|
||||
"DomainName":{
|
||||
"shape":"DomainNameString",
|
||||
"documentation":"<p>The fully qualified domain name (FQDN) for the certificate, such as www.example.com or example.com.</p>"
|
||||
"documentation":"<p>The fully qualified domain name for the certificate, such as www.example.com or example.com.</p>"
|
||||
},
|
||||
"SubjectAlternativeNames":{
|
||||
"shape":"DomainList",
|
||||
"documentation":"<p>One or more domain names (subject alternative names) included in the certificate request. After the certificate is issued, this list includes the domain names bound to the public key 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.</p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"DomainValidationOptions":{
|
||||
"shape":"DomainValidationList",
|
||||
"documentation":"<p>Contains information about the email address or addresses used for domain validation.</p>"
|
||||
"documentation":"<p>Contains information about the email address or addresses used for domain validation. This field exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>"
|
||||
},
|
||||
"Serial":{
|
||||
"shape":"String",
|
||||
|
|
@ -198,19 +222,23 @@
|
|||
},
|
||||
"Subject":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The X.500 distinguished name of the entity associated with the public key contained in the certificate.</p>"
|
||||
"documentation":"<p>The name of the entity that is associated with the public key contained in the certificate.</p>"
|
||||
},
|
||||
"Issuer":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The X.500 distinguished name of the CA that issued and signed the certificate.</p>"
|
||||
"documentation":"<p>The name of the certificate authority that issued and signed the certificate.</p>"
|
||||
},
|
||||
"CreatedAt":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The time at which the certificate was requested.</p>"
|
||||
"documentation":"<p>The time at which the certificate was requested. This value exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>"
|
||||
},
|
||||
"IssuedAt":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The time at which the certificate was issued.</p>"
|
||||
"documentation":"<p>The time at which the certificate was issued. This value exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>"
|
||||
},
|
||||
"ImportedAt":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The date and time at which the certificate was imported. This value exists only when the certificate type is <code>IMPORTED</code>.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"CertificateStatus",
|
||||
|
|
@ -234,19 +262,23 @@
|
|||
},
|
||||
"KeyAlgorithm":{
|
||||
"shape":"KeyAlgorithm",
|
||||
"documentation":"<p>The algorithm used to generate the key pair (the public and private key). Currently the only supported value is <code>RSA_2048</code>.</p>"
|
||||
"documentation":"<p>The algorithm that was used to generate the key pair (the public and private key).</p>"
|
||||
},
|
||||
"SignatureAlgorithm":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The algorithm used to generate a signature. Currently the only supported value is <code>SHA256WITHRSA</code>.</p>"
|
||||
"documentation":"<p>The algorithm that was used to sign the certificate.</p>"
|
||||
},
|
||||
"InUseBy":{
|
||||
"shape":"InUseList",
|
||||
"documentation":"<p>A list of ARNs for the resources that are using the certificate. An ACM Certificate can be used by multiple AWS resources.</p>"
|
||||
"documentation":"<p>A list of ARNs for the AWS resources that are using the certificate. A certificate can be used by multiple AWS resources.</p>"
|
||||
},
|
||||
"FailureReason":{
|
||||
"shape":"FailureReason",
|
||||
"documentation":"<p>The reason the certificate request failed. This value exists only when the structure's <code>Status</code> is <code>FAILED</code>. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed\">Certificate Request Failed</a> in the <i>AWS Certificate Manager User Guide</i>.</p>"
|
||||
"documentation":"<p>The reason the certificate request failed. This value exists only when the certificate status is <code>FAILED</code>. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed\">Certificate Request Failed</a> in the <i>AWS Certificate Manager User Guide</i>.</p>"
|
||||
},
|
||||
"Type":{
|
||||
"shape":"CertificateType",
|
||||
"documentation":"<p>The source of the certificate. For certificates provided by ACM, this value is <code>AMAZON_ISSUED</code>. For certificates that you imported with <a>ImportCertificate</a>, this value is <code>IMPORTED</code>. ACM does not provide <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html\">managed renewal</a> for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains detailed metadata about an ACM Certificate. This structure is returned in the response to a <a>DescribeCertificate</a> request.</p>"
|
||||
|
|
@ -285,6 +317,13 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"CertificateSummary"}
|
||||
},
|
||||
"CertificateType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"IMPORTED",
|
||||
"AMAZON_ISSUED"
|
||||
]
|
||||
},
|
||||
"DeleteCertificateRequest":{
|
||||
"type":"structure",
|
||||
"required":["CertificateArn"],
|
||||
|
|
@ -414,6 +453,40 @@
|
|||
"min":1,
|
||||
"pattern":"\\w+"
|
||||
},
|
||||
"ImportCertificateRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Certificate",
|
||||
"PrivateKey"
|
||||
],
|
||||
"members":{
|
||||
"CertificateArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of an imported certificate to replace. To import a new certificate, omit this field.</p>"
|
||||
},
|
||||
"Certificate":{
|
||||
"shape":"CertificateBodyBlob",
|
||||
"documentation":"<p>The certificate to import. It must meet the following requirements:</p> <ul> <li> <p>Must be PEM-encoded.</p> </li> <li> <p>Must contain a 1024-bit or 2048-bit RSA public key.</p> </li> <li> <p>Must be valid at the time of import. You cannot import a certificate before its validity period begins (the certificate's <code>NotBefore</code> date) or after it expires (the certificate's <code>NotAfter</code> date).</p> </li> </ul>"
|
||||
},
|
||||
"PrivateKey":{
|
||||
"shape":"PrivateKeyBlob",
|
||||
"documentation":"<p>The private key that matches the public key in the certificate. It must meet the following requirements:</p> <ul> <li> <p>Must be PEM-encoded.</p> </li> <li> <p>Must be unencrypted. You cannot import a private key that is protected by a password or passphrase.</p> </li> </ul>"
|
||||
},
|
||||
"CertificateChain":{
|
||||
"shape":"CertificateChainBlob",
|
||||
"documentation":"<p>The certificate chain. It must be PEM-encoded.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ImportCertificateResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CertificateArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"InUseList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
|
|
@ -454,6 +527,7 @@
|
|||
"type":"string",
|
||||
"enum":[
|
||||
"RSA_2048",
|
||||
"RSA_1024",
|
||||
"EC_prime256v1"
|
||||
]
|
||||
},
|
||||
|
|
@ -525,6 +599,12 @@
|
|||
"min":1,
|
||||
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*"
|
||||
},
|
||||
"PrivateKeyBlob":{
|
||||
"type":"blob",
|
||||
"max":524288,
|
||||
"min":1,
|
||||
"sensitive":true
|
||||
},
|
||||
"RemoveTagsFromCertificateRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -682,5 +762,5 @@
|
|||
"member":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"documentation":"<fullname>AWS Certificate Manager</fullname> <p>Welcome to the AWS Certificate Manager (ACM) Command Reference. This guide provides descriptions, syntax, and usage examples for each ACM command. You can use AWS Certificate Manager to request ACM Certificates for your AWS-based websites and applications. For general information about using ACM and for more information about using the console, see the <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html\">AWS Certificate Manager User Guide</a>. For more information about using the ACM API, see the <a href=\"http://docs.aws.amazon.com/acm/latest/APIReference/Welcome.html\">AWS Certificate Manager API Reference</a>.</p>"
|
||||
"documentation":"<fullname>AWS Certificate Manager</fullname> <p>Welcome to the AWS Certificate Manager (ACM) API documentation.</p> <p>You can use ACM to manage SSL/TLS certificates for your AWS-based websites and applications. For general information about using ACM, see the <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/\"> <i>AWS Certificate Manager User Guide</i> </a>.</p>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -42,36 +42,18 @@
|
|||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "DELETE_IN_PROGRESS",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "DELETE_FAILED",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "ROLLBACK_COMPLETE",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "ROLLBACK_FAILED",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "ROLLBACK_IN_PROGRESS",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"expected": "ValidationError",
|
||||
"matcher": "error",
|
||||
|
|
@ -102,72 +84,18 @@
|
|||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "CREATE_COMPLETE",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "CREATE_FAILED",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "CREATE_IN_PROGRESS",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "ROLLBACK_COMPLETE",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "ROLLBACK_FAILED",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "ROLLBACK_IN_PROGRESS",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "UPDATE_COMPLETE",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "UPDATE_IN_PROGRESS",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "UPDATE_ROLLBACK_COMPLETE",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "UPDATE_ROLLBACK_FAILED",
|
||||
|
|
@ -200,30 +128,12 @@
|
|||
"state": "failure",
|
||||
"argument": "Stacks[].StackStatus"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "UPDATE_ROLLBACK_COMPLETE",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "UPDATE_ROLLBACK_FAILED",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "UPDATE_ROLLBACK_IN_PROGRESS",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"expected": "ValidationError",
|
||||
"matcher": "error",
|
||||
|
|
|
|||
0
botocore/data/cloudfront/2016-08-20/service-2.json
Executable file → Normal file
0
botocore/data/cloudfront/2016-08-20/service-2.json
Executable file → Normal file
32
botocore/data/cloudfront/2016-09-29/paginators-1.json
Normal file
32
botocore/data/cloudfront/2016-09-29/paginators-1.json
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
{
|
||||
"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"
|
||||
}
|
||||
}
|
||||
}
|
||||
3496
botocore/data/cloudfront/2016-09-29/service-2.json
Normal file
3496
botocore/data/cloudfront/2016-09-29/service-2.json
Normal file
|
|
@ -0,0 +1,3496 @@
|
|||
{
|
||||
"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":"<p>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 <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"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":"<p>Creates a new web distribution. Send a <code>GET</code> request to the <code>/<i>CloudFront API version</i>/distribution</code>/<code>distribution ID</code> resource.</p>"
|
||||
},
|
||||
"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":"<p>Create a new distribution with tags.</p>"
|
||||
},
|
||||
"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":"<p>Create a new invalidation. </p>"
|
||||
},
|
||||
"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":"<p>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. </p> <p>To create a new web distribution, submit a <code>POST</code> request to the <i>CloudFront API version</i>/distribution resource. The request body must include a document with a <i>StreamingDistributionConfig</i> element. The response echoes the <code>StreamingDistributionConfig</code> element and returns other information about the RTMP distribution.</p> <p>To get the status of your request, use the <i>GET StreamingDistribution</i> API action. When the value of <code>Enabled</code> is <code>true</code> and the value of <code>Status</code> is <code>Deployed</code>, your distribution is ready. A distribution usually deploys in less than 15 minutes.</p> <p>For more information about web distributions, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-rtmp.html\">Working with RTMP Distributions</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <important> <p>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 <code>Quantity</code> element and the number of values specified.</p> </important>"
|
||||
},
|
||||
"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":"<p>Create a new streaming distribution with tags.</p>"
|
||||
},
|
||||
"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":"<p>Delete an origin access identity. </p>"
|
||||
},
|
||||
"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":"<p>Delete a distribution. </p>"
|
||||
},
|
||||
"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":"<p>Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.</p> <p> <b>To delete an RTMP distribution using the CloudFront API</b>:</p> <ol> <li> <p>Disable the RTMP distribution.</p> </li> <li> <p>Submit a <code>GET Streaming Distribution Config</code> request to get the current configuration and the <code>Etag</code> header for the distribution. </p> </li> <li> <p>Update the XML document that was returned in the response to your <code>GET Streaming Distribution Config</code> request to change the value of <code>Enabled</code> to <code>false</code>.</p> </li> <li> <p>Submit a <code>PUT Streaming Distribution Config</code> 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 <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Streaming Distribution Config</code> request in Step 2.</p> </li> <li> <p>Review the response to the <code>PUT Streaming Distribution Config</code> request to confirm that the distribution was successfully disabled.</p> </li> <li> <p>Submit a <code>GET Streaming Distribution Config</code> request to confirm that your changes have propagated. When propagation is complete, the value of <code>Status</code> is <code>Deployed</code>.</p> </li> <li> <p>Submit a <code>DELETE Streaming Distribution</code> request. Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Streaming Distribution Config</code> request in Step 2.</p> </li> <li> <p>Review the response to your <code>DELETE Streaming Distribution</code> request to confirm that the distribution was successfully deleted.</p> </li> </ol> <p>For information about deleting a distribution using the CloudFront console, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html\">Deleting a Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"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":"<p>Get the information about an origin access identity. </p>"
|
||||
},
|
||||
"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":"<p>Get the configuration information about an origin access identity. </p>"
|
||||
},
|
||||
"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":"<p>Get the information about a distribution. </p>"
|
||||
},
|
||||
"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":"<p>Get the configuration information about a distribution. </p>"
|
||||
},
|
||||
"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":"<p>Get the information about an invalidation. </p>"
|
||||
},
|
||||
"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":"<p>Gets information about a specified RTMP distribution, including the distribution configuration.</p>"
|
||||
},
|
||||
"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":"<p>Get the configuration information about a streaming distribution. </p>"
|
||||
},
|
||||
"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":"<p>Lists origin access identities.</p>"
|
||||
},
|
||||
"ListDistributions":{
|
||||
"name":"ListDistributions2016_09_29",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/2016-09-29/distribution"
|
||||
},
|
||||
"input":{"shape":"ListDistributionsRequest"},
|
||||
"output":{"shape":"ListDistributionsResult"},
|
||||
"errors":[
|
||||
{"shape":"InvalidArgument"}
|
||||
],
|
||||
"documentation":"<p>List distributions. </p>"
|
||||
},
|
||||
"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":"<p>List the distributions that are associated with a specified AWS WAF web ACL. </p>"
|
||||
},
|
||||
"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":"<p>Lists invalidation batches. </p>"
|
||||
},
|
||||
"ListStreamingDistributions":{
|
||||
"name":"ListStreamingDistributions2016_09_29",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/2016-09-29/streaming-distribution"
|
||||
},
|
||||
"input":{"shape":"ListStreamingDistributionsRequest"},
|
||||
"output":{"shape":"ListStreamingDistributionsResult"},
|
||||
"errors":[
|
||||
{"shape":"InvalidArgument"}
|
||||
],
|
||||
"documentation":"<p>List streaming distributions. </p>"
|
||||
},
|
||||
"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":"<p>List tags for a CloudFront resource.</p>"
|
||||
},
|
||||
"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":"<p>Add tags to a CloudFront resource.</p>"
|
||||
},
|
||||
"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":"<p>Remove tags from a CloudFront resource.</p>"
|
||||
},
|
||||
"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":"<p>Update an origin access identity. </p>"
|
||||
},
|
||||
"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":"<p>Update a distribution. </p>"
|
||||
},
|
||||
"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":"<p>Update a streaming distribution. </p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AccessDenied":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>Access denied.</p>",
|
||||
"error":{"httpStatusCode":403},
|
||||
"exception":true
|
||||
},
|
||||
"ActiveTrustedSigners":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Enabled",
|
||||
"Quantity"
|
||||
],
|
||||
"members":{
|
||||
"Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Enabled is <code>true</code> if any of the AWS accounts listed in the <code>TrustedSigners</code> complex type for this RTMP distribution have active CloudFront key pairs. If not, <code>Enabled</code> is <code>false</code>.</p> <p>For more information, see <a>ActiveTrustedSigners</a>.</p>"
|
||||
},
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>A complex type that contains one <code>Signer</code> complex type for each trusted signer specified in the <code>TrustedSigners</code> complex type.</p> <p>For more information, see <a>ActiveTrustedSigners</a>.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"SignerList",
|
||||
"documentation":"<p>A complex type that contains one <code>Signer</code> complex type for each trusted signer that is specified in the <code>TrustedSigners</code> complex type.</p> <p>For more information, see <a>ActiveTrustedSigners</a>. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that lists the AWS accounts, if any, that you included in the <code>TrustedSigners</code> complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.</p> <p>The <code>Signer</code> complex type lists the AWS account number of the trusted signer or <code>self</code> if the signer is the AWS account that created the distribution. The <code>Signer</code> element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no <code>KeyPairId</code> element appears for a <code>Signer</code>, that signer can't create signed URLs. </p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"AliasList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"string",
|
||||
"locationName":"CNAME"
|
||||
}
|
||||
},
|
||||
"Aliases":{
|
||||
"type":"structure",
|
||||
"required":["Quantity"],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of CNAME aliases, if any, that you want to associate with this distribution.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"AliasList",
|
||||
"documentation":"<p>A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution. </p>"
|
||||
},
|
||||
"AllowedMethods":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Quantity",
|
||||
"Items"
|
||||
],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for <code>GET</code> and <code>HEAD</code> requests), 3 (for <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests) and 7 (for <code>GET, HEAD, OPTIONS, PUT, PATCH, POST</code>, and <code>DELETE</code> requests).</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"MethodsList",
|
||||
"documentation":"<p>A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.</p>"
|
||||
},
|
||||
"CachedMethods":{"shape":"CachedMethods"}
|
||||
},
|
||||
"documentation":"<p>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:</p> <ul> <li> <p>CloudFront forwards only <code>GET</code> and <code>HEAD</code> requests.</p> </li> <li> <p>CloudFront forwards only <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests.</p> </li> <li> <p>CloudFront forwards <code>GET, HEAD, OPTIONS, PUT, PATCH, POST</code>, and <code>DELETE</code> requests.</p> </li> </ul> <p>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.</p>"
|
||||
},
|
||||
"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":"<p>The pattern (for example, <code>images/*.jpg</code>) 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.</p> <note> <p>You can optionally include a slash (<code>/</code>) at the beginning of the path pattern. For example, <code>/images/*.jpg</code>. CloudFront behavior is the same with or without the leading <code>/</code>.</p> </note> <p>The path pattern for the default cache behavior is <code>*</code> 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.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern\">Path Pattern</a> in the <i> Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"TargetOriginId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value of <code>ID</code> 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.</p>"
|
||||
},
|
||||
"ForwardedValues":{
|
||||
"shape":"ForwardedValues",
|
||||
"documentation":"<p>A complex type that specifies how CloudFront handles query strings and cookies.</p>"
|
||||
},
|
||||
"TrustedSigners":{
|
||||
"shape":"TrustedSigners",
|
||||
"documentation":"<p>A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.</p> <p>If you want to require signed URLs in requests for objects in the target origin that match the <code>PathPattern</code> for this cache behavior, specify <code>true</code> for <code>Enabled</code>, and specify the applicable values for <code>Quantity</code> and <code>Items</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p> <p>If you don't want to require signed URLs in requests for objects that match <code>PathPattern</code>, specify <code>false</code> for <code>Enabled</code> and <code>0</code> for <code>Quantity</code>. Omit <code>Items</code>.</p> <p>To add, change, or remove one or more trusted signers, change <code>Enabled</code> to <code>true</code> (if it's currently <code>false</code>), change <code>Quantity</code> as applicable, and specify all of the trusted signers that you want to include in the updated distribution.</p>"
|
||||
},
|
||||
"ViewerProtocolPolicy":{
|
||||
"shape":"ViewerProtocolPolicy",
|
||||
"documentation":"<p>The protocol that viewers can use to access the files in the origin specified by <code>TargetOriginId</code> when a request matches the path pattern in <code>PathPattern</code>. You can specify the following options:</p> <ul> <li> <p> <code>allow-all</code>: Viewers can use HTTP or HTTPS.</p> </li> <li> <p> <code>redirect-to-https</code>: 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. </p> </li> <li> <p> <code>https-only</code>: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). </p> </li> </ul> <p>For more information about requiring the HTTPS protocol, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html\">Using an HTTPS Connection to Access Your Objects</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <note> <p>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 <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </note>"
|
||||
},
|
||||
"MinTTL":{
|
||||
"shape":"long",
|
||||
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p> <p>You must specify <code>0</code> for <code>MinTTL</code> if you configure CloudFront to forward all headers to your origin (under <code>Headers</code>, if you specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>).</p>"
|
||||
},
|
||||
"AllowedMethods":{"shape":"AllowedMethods"},
|
||||
"SmoothStreaming":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>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 <code>true</code>; if not, specify <code>false</code>. If you specify <code>true</code> for <code>SmoothStreaming</code>, you can still distribute other content using this cache behavior if the content matches the value of <code>PathPattern</code>. </p>"
|
||||
},
|
||||
"DefaultTTL":{
|
||||
"shape":"long",
|
||||
"documentation":"<p>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 <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and <code>Expires</code> to objects. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"MaxTTL":{
|
||||
"shape":"long",
|
||||
"documentation":"<p>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 <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and <code>Expires</code> to objects. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"Compress":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html\">Serving Compressed Files</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that describes how CloudFront processes requests.</p> <p>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.</p> <p>For the current limit on the number of cache behaviors that you can add to a distribution, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_cloudfront\">Amazon CloudFront Limits</a> in the <i>AWS General Reference</i>.</p> <p>If you don't want to specify any cache behaviors, include only an empty <code>CacheBehaviors</code> element. Don't include an empty <code>CacheBehavior</code> element, or CloudFront returns a <code>MalformedXML</code> error.</p> <p>To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty <code>CacheBehaviors</code> element.</p> <p>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.</p> <p>For more information about cache behaviors, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior\">Cache Behaviors</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"CacheBehaviorList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"CacheBehavior",
|
||||
"locationName":"CacheBehavior"
|
||||
}
|
||||
},
|
||||
"CacheBehaviors":{
|
||||
"type":"structure",
|
||||
"required":["Quantity"],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of cache behaviors for this distribution. </p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"CacheBehaviorList",
|
||||
"documentation":"<p>Optional: A complex type that contains cache behaviors for this distribution. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that contains zero or more <code>CacheBehavior</code> elements. </p>"
|
||||
},
|
||||
"CachedMethods":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Quantity",
|
||||
"Items"
|
||||
],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of HTTP methods for which you want CloudFront to cache responses. Valid values are <code>2</code> (for caching responses to <code>GET</code> and <code>HEAD</code> requests) and <code>3</code> (for caching responses to <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests).</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"MethodsList",
|
||||
"documentation":"<p>A complex type that contains the HTTP methods that you want CloudFront to cache responses to.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:</p> <ul> <li> <p>CloudFront caches responses to <code>GET</code> and <code>HEAD</code> requests.</p> </li> <li> <p>CloudFront caches responses to <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests.</p> </li> </ul> <p>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. </p>"
|
||||
},
|
||||
"CertificateSource":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"cloudfront",
|
||||
"iam",
|
||||
"acm"
|
||||
]
|
||||
},
|
||||
"CloudFrontOriginAccessIdentity":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Id",
|
||||
"S3CanonicalUserId"
|
||||
],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The ID for the origin access identity. For example: <code>E74FTE3AJFJ256A</code>. </p>"
|
||||
},
|
||||
"S3CanonicalUserId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>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. </p>"
|
||||
},
|
||||
"CloudFrontOriginAccessIdentityConfig":{
|
||||
"shape":"CloudFrontOriginAccessIdentityConfig",
|
||||
"documentation":"<p>The current configuration information for the identity. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>CloudFront origin access identity.</p>"
|
||||
},
|
||||
"CloudFrontOriginAccessIdentityAlreadyExists":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>If the <code>CallerReference</code> is a value you already sent in a previous request to create an identity but the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is different from the original request, CloudFront returns a <code>CloudFrontOriginAccessIdentityAlreadyExists</code> error. </p>",
|
||||
"error":{"httpStatusCode":409},
|
||||
"exception":true
|
||||
},
|
||||
"CloudFrontOriginAccessIdentityConfig":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"CallerReference",
|
||||
"Comment"
|
||||
],
|
||||
"members":{
|
||||
"CallerReference":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>A unique number that ensures the request can't be replayed.</p> <p>If the <code>CallerReference</code> is new (no matter the content of the <code>CloudFrontOriginAccessIdentityConfig</code> object), a new origin access identity is created.</p> <p>If the <code>CallerReference</code> is a value already sent in a previous identity request, and the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is identical to the original request (ignoring white space), the response includes the same information returned to the original request. </p> <p>If the <code>CallerReference</code> is a value you already sent in a previous request to create an identity, but the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is different from the original request, CloudFront returns a <code>CloudFrontOriginAccessIdentityAlreadyExists</code> error. </p>"
|
||||
},
|
||||
"Comment":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Any comments you want to include about the origin access identity. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Origin access identity configuration. Send a <code>GET</code> request to the <code>/<i>CloudFront API version</i>/CloudFront/identity ID/config</code> resource. </p>"
|
||||
},
|
||||
"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":"<p>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 <code>Marker</code> to the value of the <code>NextMarker</code> from the current page's response (which is also the ID of the last identity on that page). </p>"
|
||||
},
|
||||
"NextMarker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>If <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value you can use for the <code>Marker</code> request parameter to continue listing your origin access identities where they left off. </p>"
|
||||
},
|
||||
"MaxItems":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The maximum number of origin access identities you want in the response body. </p>"
|
||||
},
|
||||
"IsTruncated":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>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 <code>Marker</code> request parameter to retrieve more items in the list.</p>"
|
||||
},
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of CloudFront origin access identities that were created by the current AWS account. </p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"CloudFrontOriginAccessIdentitySummaryList",
|
||||
"documentation":"<p>A complex type that contains one <code>CloudFrontOriginAccessIdentitySummary</code> element for each origin access identity that was created by the current AWS account.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Lists the origin access identities for CloudFront.Send a <code>GET</code> request to the <code>/<i>CloudFront API version</i>/origin-access-identity/cloudfront</code> resource. The response includes a <code>CloudFrontOriginAccessIdentityList</code> element with zero or more <code>CloudFrontOriginAccessIdentitySummary</code> 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 <code>MaxItems</code> and <code>Marker</code> parameters.</p>"
|
||||
},
|
||||
"CloudFrontOriginAccessIdentitySummary":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Id",
|
||||
"S3CanonicalUserId",
|
||||
"Comment"
|
||||
],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The ID for the origin access identity. For example: <code>E74FTE3AJFJ256A</code>.</p>"
|
||||
},
|
||||
"S3CanonicalUserId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"Comment":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The comment for this origin access identity, as originally specified when created.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Summary of the information about a CloudFront origin access identity.</p>"
|
||||
},
|
||||
"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":"<p>The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"CookieNameList",
|
||||
"documentation":"<p>A complex type that contains one <code>Name</code> element for each cookie that you want CloudFront to forward to the origin for this cache behavior.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html\">How CloudFront Forwards, Caches, and Logs Cookies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"CookiePreference":{
|
||||
"type":"structure",
|
||||
"required":["Forward"],
|
||||
"members":{
|
||||
"Forward":{
|
||||
"shape":"ItemSelection",
|
||||
"documentation":"<p>Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the <code>WhitelistedNames</code> complex type.</p> <p>Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the <code>Forward</code> element. </p>"
|
||||
},
|
||||
"WhitelistedNames":{
|
||||
"shape":"CookieNames",
|
||||
"documentation":"<p>Required if you specify <code>whitelist</code> for the value of <code>Forward:</code>. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.</p> <p>If you specify <code>all</code> or none for the value of <code>Forward</code>, omit <code>WhitelistedNames</code>. If you change the value of <code>Forward</code> from <code>whitelist</code> to all or none and you don't delete the <code>WhitelistedNames</code> element and its child elements, CloudFront deletes them automatically.</p> <p>For the current limit on the number of cookie names that you can whitelist for each cache behavior, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_cloudfront\">Amazon CloudFront Limits</a> in the <i>AWS General Reference</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html\">How CloudFront Forwards, Caches, and Logs Cookies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"CreateCloudFrontOriginAccessIdentityRequest":{
|
||||
"type":"structure",
|
||||
"required":["CloudFrontOriginAccessIdentityConfig"],
|
||||
"members":{
|
||||
"CloudFrontOriginAccessIdentityConfig":{
|
||||
"shape":"CloudFrontOriginAccessIdentityConfig",
|
||||
"documentation":"<p>The current configuration information for the identity.</p>",
|
||||
"locationName":"CloudFrontOriginAccessIdentityConfig",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to create a new origin access identity.</p>",
|
||||
"payload":"CloudFrontOriginAccessIdentityConfig"
|
||||
},
|
||||
"CreateCloudFrontOriginAccessIdentityResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CloudFrontOriginAccessIdentity":{
|
||||
"shape":"CloudFrontOriginAccessIdentity",
|
||||
"documentation":"<p>The origin access identity's information.</p>"
|
||||
},
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the new origin access identity just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the origin access identity created.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"CloudFrontOriginAccessIdentity"
|
||||
},
|
||||
"CreateDistributionRequest":{
|
||||
"type":"structure",
|
||||
"required":["DistributionConfig"],
|
||||
"members":{
|
||||
"DistributionConfig":{
|
||||
"shape":"DistributionConfig",
|
||||
"documentation":"<p>The distribution's configuration information.</p>",
|
||||
"locationName":"DistributionConfig",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to create a new distribution.</p>",
|
||||
"payload":"DistributionConfig"
|
||||
},
|
||||
"CreateDistributionResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Distribution":{
|
||||
"shape":"Distribution",
|
||||
"documentation":"<p>The distribution's information.</p>"
|
||||
},
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the new distribution resource just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the distribution created.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"Distribution"
|
||||
},
|
||||
"CreateDistributionWithTagsRequest":{
|
||||
"type":"structure",
|
||||
"required":["DistributionConfigWithTags"],
|
||||
"members":{
|
||||
"DistributionConfigWithTags":{
|
||||
"shape":"DistributionConfigWithTags",
|
||||
"documentation":"<p>The distribution's configuration information. </p>",
|
||||
"locationName":"DistributionConfigWithTags",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to create a new distribution with tags. </p>",
|
||||
"payload":"DistributionConfigWithTags"
|
||||
},
|
||||
"CreateDistributionWithTagsResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Distribution":{
|
||||
"shape":"Distribution",
|
||||
"documentation":"<p>The distribution's information. </p>"
|
||||
},
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the new distribution resource just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5</code>. </p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the distribution created.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request. </p>",
|
||||
"payload":"Distribution"
|
||||
},
|
||||
"CreateInvalidationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DistributionId",
|
||||
"InvalidationBatch"
|
||||
],
|
||||
"members":{
|
||||
"DistributionId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The distribution's id.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"DistributionId"
|
||||
},
|
||||
"InvalidationBatch":{
|
||||
"shape":"InvalidationBatch",
|
||||
"documentation":"<p>The batch information for the invalidation.</p>",
|
||||
"locationName":"InvalidationBatch",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to create an invalidation.</p>",
|
||||
"payload":"InvalidationBatch"
|
||||
},
|
||||
"CreateInvalidationResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the distribution and invalidation batch request, including the <code>Invalidation ID</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
"Invalidation":{
|
||||
"shape":"Invalidation",
|
||||
"documentation":"<p>The invalidation's information.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"Invalidation"
|
||||
},
|
||||
"CreateStreamingDistributionRequest":{
|
||||
"type":"structure",
|
||||
"required":["StreamingDistributionConfig"],
|
||||
"members":{
|
||||
"StreamingDistributionConfig":{
|
||||
"shape":"StreamingDistributionConfig",
|
||||
"documentation":"<p>The streaming distribution's configuration information.</p>",
|
||||
"locationName":"StreamingDistributionConfig",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to create a new streaming distribution.</p>",
|
||||
"payload":"StreamingDistributionConfig"
|
||||
},
|
||||
"CreateStreamingDistributionResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"StreamingDistribution":{
|
||||
"shape":"StreamingDistribution",
|
||||
"documentation":"<p>The streaming distribution's information.</p>"
|
||||
},
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the new streaming distribution resource just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the streaming distribution created.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"StreamingDistribution"
|
||||
},
|
||||
"CreateStreamingDistributionWithTagsRequest":{
|
||||
"type":"structure",
|
||||
"required":["StreamingDistributionConfigWithTags"],
|
||||
"members":{
|
||||
"StreamingDistributionConfigWithTags":{
|
||||
"shape":"StreamingDistributionConfigWithTags",
|
||||
"documentation":"<p> The streaming distribution's configuration information. </p>",
|
||||
"locationName":"StreamingDistributionConfigWithTags",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to create a new streaming distribution with tags.</p>",
|
||||
"payload":"StreamingDistributionConfigWithTags"
|
||||
},
|
||||
"CreateStreamingDistributionWithTagsResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"StreamingDistribution":{
|
||||
"shape":"StreamingDistribution",
|
||||
"documentation":"<p>The streaming distribution's information. </p>"
|
||||
},
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the new streaming distribution resource just created. For example:<code> https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request. </p>",
|
||||
"payload":"StreamingDistribution"
|
||||
},
|
||||
"CustomErrorResponse":{
|
||||
"type":"structure",
|
||||
"required":["ErrorCode"],
|
||||
"members":{
|
||||
"ErrorCode":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The HTTP status code for which you want to specify a custom error page and/or a caching duration.</p>"
|
||||
},
|
||||
"ResponsePagePath":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by <code>ErrorCode</code>, for example, <code>/4xx-errors/403-forbidden.html</code>. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:</p> <ul> <li> <p>The value of <code>PathPattern</code> matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named <code>/4xx-errors</code>. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, <code>/4xx-errors/*</code>. </p> </li> <li> <p>The value of <code>TargetOriginId</code> specifies the value of the <code>ID</code> element for the origin that contains your custom error pages.</p> </li> </ul> <p>If you specify a value for <code>ResponsePagePath</code>, you must also specify a value for <code>ResponseCode</code>. If you don't want to specify a value, include an empty element, <code><ResponsePagePath></code>, in the XML document.</p> <p>We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.</p>"
|
||||
},
|
||||
"ResponseCode":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:</p> <ul> <li> <p>Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute <code>200</code>, the response typically won't be intercepted.</p> </li> <li> <p>If you don't care about distinguishing among different client errors or server errors, you can specify <code>400</code> or <code>500</code> as the <code>ResponseCode</code> for all 4xx or 5xx errors.</p> </li> <li> <p>You might want to return a <code>200</code> status code (OK) and static website so your customers don't know that your website is down.</p> </li> </ul> <p>If you specify a value for <code>ResponseCode</code>, you must also specify a value for <code>ResponsePagePath</code>. If you don't want to specify a value, include an empty element, <code><ResponseCode></code>, in the XML document.</p>"
|
||||
},
|
||||
"ErrorCachingMinTTL":{
|
||||
"shape":"long",
|
||||
"documentation":"<p>The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in <code>ErrorCode</code>. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.</p> <p>If you don't want to specify a value, include an empty element, <code><ErrorCachingMinTTL></code>, in the XML document.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html\">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that controls:</p> <ul> <li> <p>Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. </p> </li> <li> <p>How long CloudFront caches HTTP status codes in the 4xx and 5xx range.</p> </li> </ul> <p>For more information about custom error pages, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html\">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"CustomErrorResponseList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"CustomErrorResponse",
|
||||
"locationName":"CustomErrorResponse"
|
||||
}
|
||||
},
|
||||
"CustomErrorResponses":{
|
||||
"type":"structure",
|
||||
"required":["Quantity"],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"CustomErrorResponseList",
|
||||
"documentation":"<p>A complex type that contains a <code>CustomErrorResponse</code> element for each HTTP status code for which you want to specify a custom error page and/or a caching duration. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that controls:</p> <ul> <li> <p>Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.</p> </li> <li> <p>How long CloudFront caches HTTP status codes in the 4xx and 5xx range.</p> </li> </ul> <p>For more information about custom error pages, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html\">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"CustomHeaders":{
|
||||
"type":"structure",
|
||||
"required":["Quantity"],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of custom headers, if any, for this distribution.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"OriginCustomHeadersList",
|
||||
"documentation":"<p> <b>Optional</b>: A list that contains one <code>OriginCustomHeader</code> element for each custom header that you want CloudFront to forward to the origin. If Quantity is <code>0</code>, omit <code>Items</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that contains the list of Custom Headers for each origin. </p>"
|
||||
},
|
||||
"CustomOriginConfig":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"HTTPPort",
|
||||
"HTTPSPort",
|
||||
"OriginProtocolPolicy"
|
||||
],
|
||||
"members":{
|
||||
"HTTPPort":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The HTTP port the custom origin listens on.</p>"
|
||||
},
|
||||
"HTTPSPort":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The HTTPS port the custom origin listens on.</p>"
|
||||
},
|
||||
"OriginProtocolPolicy":{
|
||||
"shape":"OriginProtocolPolicy",
|
||||
"documentation":"<p>The origin protocol policy to apply to your origin.</p>"
|
||||
},
|
||||
"OriginSslProtocols":{
|
||||
"shape":"OriginSslProtocols",
|
||||
"documentation":"<p>The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A customer origin.</p>"
|
||||
},
|
||||
"DefaultCacheBehavior":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"TargetOriginId",
|
||||
"ForwardedValues",
|
||||
"TrustedSigners",
|
||||
"ViewerProtocolPolicy",
|
||||
"MinTTL"
|
||||
],
|
||||
"members":{
|
||||
"TargetOriginId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value of <code>ID</code> 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.</p>"
|
||||
},
|
||||
"ForwardedValues":{
|
||||
"shape":"ForwardedValues",
|
||||
"documentation":"<p>A complex type that specifies how CloudFront handles query strings and cookies.</p>"
|
||||
},
|
||||
"TrustedSigners":{
|
||||
"shape":"TrustedSigners",
|
||||
"documentation":"<p>A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.</p> <p>If you want to require signed URLs in requests for objects in the target origin that match the <code>PathPattern</code> for this cache behavior, specify <code>true</code> for <code>Enabled</code>, and specify the applicable values for <code>Quantity</code> and <code>Items</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p> <p>If you don't want to require signed URLs in requests for objects that match <code>PathPattern</code>, specify <code>false</code> for <code>Enabled</code> and <code>0</code> for <code>Quantity</code>. Omit <code>Items</code>.</p> <p>To add, change, or remove one or more trusted signers, change <code>Enabled</code> to <code>true</code> (if it's currently <code>false</code>), change <code>Quantity</code> as applicable, and specify all of the trusted signers that you want to include in the updated distribution.</p>"
|
||||
},
|
||||
"ViewerProtocolPolicy":{
|
||||
"shape":"ViewerProtocolPolicy",
|
||||
"documentation":"<p>The protocol that viewers can use to access the files in the origin specified by <code>TargetOriginId</code> when a request matches the path pattern in <code>PathPattern</code>. You can specify the following options:</p> <ul> <li> <p> <code>allow-all</code>: Viewers can use HTTP or HTTPS.</p> </li> <li> <p> <code>redirect-to-https</code>: 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.</p> </li> <li> <p> <code>https-only</code>: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).</p> </li> </ul> <p>For more information about requiring the HTTPS protocol, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html\">Using an HTTPS Connection to Access Your Objects</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <note> <p>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 <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </note>"
|
||||
},
|
||||
"MinTTL":{
|
||||
"shape":"long",
|
||||
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p> <p>You must specify <code>0</code> for <code>MinTTL</code> if you configure CloudFront to forward all headers to your origin (under <code>Headers</code>, if you specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>).</p>"
|
||||
},
|
||||
"AllowedMethods":{"shape":"AllowedMethods"},
|
||||
"SmoothStreaming":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>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 <code>true</code>; if not, specify <code>false</code>. If you specify <code>true</code> for <code>SmoothStreaming</code>, you can still distribute other content using this cache behavior if the content matches the value of <code>PathPattern</code>. </p>"
|
||||
},
|
||||
"DefaultTTL":{
|
||||
"shape":"long",
|
||||
"documentation":"<p>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 <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and <code>Expires</code> to objects. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"MaxTTL":{"shape":"long"},
|
||||
"Compress":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify <code>true</code>; if not, specify <code>false</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html\">Serving Compressed Files</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that describes the default cache behavior if you do not specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>"
|
||||
},
|
||||
"DeleteCloudFrontOriginAccessIdentityRequest":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The origin access identity's ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
},
|
||||
"IfMatch":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value of the <code>ETag</code> header you received from a previous <code>GET</code> or <code>PUT</code> request. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"If-Match"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Deletes a origin access identity.</p>"
|
||||
},
|
||||
"DeleteDistributionRequest":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The distribution ID. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
},
|
||||
"IfMatch":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value of the <code>ETag</code> header that you received when you disabled the distribution. For example: <code>E2QWRUHAPOMQZL</code>. </p>",
|
||||
"location":"header",
|
||||
"locationName":"If-Match"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.</p> <p> <b>To delete a web distribution using the CloudFront API:</b> </p> <ol> <li> <p>Disable the web distribution </p> </li> <li> <p>Submit a <code>GET Distribution Config</code> request to get the current configuration and the <code>Etag</code> header for the distribution.</p> </li> <li> <p>Update the XML document that was returned in the response to your <code>GET Distribution Config</code> request to change the value of <code>Enabled</code> to <code>false</code>.</p> </li> <li> <p>Submit a <code>PUT Distribution Config</code> 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 <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Distribution Config</code> request in Step 2.</p> </li> <li> <p>Review the response to the <code>PUT Distribution Config</code> request to confirm that the distribution was successfully disabled.</p> </li> <li> <p>Submit a <code>GET Distribution</code> request to confirm that your changes have propagated. When propagation is complete, the value of <code>Status</code> is <code>Deployed</code>.</p> </li> <li> <p>Submit a <code>DELETE Distribution</code> request. Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Distribution Config</code> request in Step 6.</p> </li> <li> <p>Review the response to your <code>DELETE Distribution</code> request to confirm that the distribution was successfully deleted.</p> </li> </ol> <p>For information about deleting a distribution using the CloudFront console, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html\">Deleting a Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"DeleteStreamingDistributionRequest":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The distribution ID. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
},
|
||||
"IfMatch":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value of the <code>ETag</code> header that you received when you disabled the streaming distribution. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"If-Match"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to delete a streaming distribution.</p>"
|
||||
},
|
||||
"Distribution":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Id",
|
||||
"ARN",
|
||||
"Status",
|
||||
"LastModifiedTime",
|
||||
"InProgressInvalidationBatches",
|
||||
"DomainName",
|
||||
"ActiveTrustedSigners",
|
||||
"DistributionConfig"
|
||||
],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The identifier for the distribution. For example: <code>EDFDVBD632BHDS5</code>. </p>"
|
||||
},
|
||||
"ARN":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The ARN (Amazon Resource Name) for the distribution. For example: <code>arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5</code>, where <code>123456789012</code> is your AWS account ID.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>This response element indicates the current status of the distribution. When the status is <code>Deployed</code>, the distribution's information is fully propagated to all CloudFront edge locations. </p>"
|
||||
},
|
||||
"LastModifiedTime":{
|
||||
"shape":"timestamp",
|
||||
"documentation":"<p>The date and time the distribution was last modified. </p>"
|
||||
},
|
||||
"InProgressInvalidationBatches":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of invalidation batches currently in progress. </p>"
|
||||
},
|
||||
"DomainName":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The domain name corresponding to the distribution. For example: <code>d604721fxaaqy9.cloudfront.net</code>. </p>"
|
||||
},
|
||||
"ActiveTrustedSigners":{
|
||||
"shape":"ActiveTrustedSigners",
|
||||
"documentation":"<p>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 <code>Signer</code> child element lists the AWS account number of the trusted signer (or an empty <code>Self</code> element if the signer is you). The <code>Signer</code> element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no <code>KeyPairId</code> element appears for a <code>Signer</code>, that signer can't create working signed URLs.</p>"
|
||||
},
|
||||
"DistributionConfig":{
|
||||
"shape":"DistributionConfig",
|
||||
"documentation":"<p>The current configuration information for the distribution. Send a <code>GET</code> request to the <code>/<i>CloudFront API version</i>/distribution ID/config</code> resource.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The distribution's information.</p>"
|
||||
},
|
||||
"DistributionAlreadyExists":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The caller reference you attempted to create the distribution with is associated with another distribution.</p>",
|
||||
"error":{"httpStatusCode":409},
|
||||
"exception":true
|
||||
},
|
||||
"DistributionConfig":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"CallerReference",
|
||||
"Origins",
|
||||
"DefaultCacheBehavior",
|
||||
"Comment",
|
||||
"Enabled"
|
||||
],
|
||||
"members":{
|
||||
"CallerReference":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.</p> <p>If the value of <code>CallerReference</code> is new (regardless of the content of the <code>DistributionConfig</code> object), CloudFront creates a new distribution.</p> <p>If <code>CallerReference</code> is a value you already sent in a previous request to create a distribution, and if the content of the <code>DistributionConfig</code> is identical to the original request (ignoring white space), CloudFront returns the same the response that it returned to the original request.</p> <p>If <code>CallerReference</code> is a value you already sent in a previous request to create a distribution but the content of the <code>DistributionConfig</code> is different from the original request, CloudFront returns a <code>DistributionAlreadyExists</code> error.</p>"
|
||||
},
|
||||
"Aliases":{
|
||||
"shape":"Aliases",
|
||||
"documentation":"<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.</p>"
|
||||
},
|
||||
"DefaultRootObject":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The object that you want CloudFront to request from your origin (for example, <code>index.html</code>) when a viewer requests the root URL for your distribution (<code>http://www.example.com</code>) instead of an object in your distribution (<code>http://www.example.com/product-description.html</code>). Specifying a default root object avoids exposing the contents of your distribution.</p> <p>Specify only the object name, for example, <code>index.html</code>. Do not add a <code>/</code> before the object name.</p> <p>If you don't want to specify a default root object when you create a distribution, include an empty <code>DefaultRootObject</code> element.</p> <p>To delete the default root object from an existing distribution, update the distribution configuration and include an empty <code>DefaultRootObject</code> element.</p> <p>To replace the default root object, update the distribution configuration and specify the new object.</p> <p>For more information about the default root object, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html\">Creating a Default Root Object</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"Origins":{
|
||||
"shape":"Origins",
|
||||
"documentation":"<p>A complex type that contains information about origins for this distribution. </p>"
|
||||
},
|
||||
"DefaultCacheBehavior":{
|
||||
"shape":"DefaultCacheBehavior",
|
||||
"documentation":"<p>A complex type that describes the default cache behavior if you do not specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>"
|
||||
},
|
||||
"CacheBehaviors":{
|
||||
"shape":"CacheBehaviors",
|
||||
"documentation":"<p>A complex type that contains zero or more <code>CacheBehavior</code> elements. </p>"
|
||||
},
|
||||
"CustomErrorResponses":{
|
||||
"shape":"CustomErrorResponses",
|
||||
"documentation":"<p>A complex type that controls the following:</p> <ul> <li> <p>Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.</p> </li> <li> <p>How long CloudFront caches HTTP status codes in the 4xx and 5xx range.</p> </li> </ul> <p>For more information about custom error pages, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html\">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"Comment":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Any comments you want to include about the distribution.</p> <p>If you don't want to specify a comment, include an empty <code>Comment</code> element.</p> <p>To delete an existing comment, update the distribution configuration and include an empty <code>Comment</code> element.</p> <p>To add or change a comment, update the distribution configuration and specify the new comment.</p>"
|
||||
},
|
||||
"Logging":{
|
||||
"shape":"LoggingConfig",
|
||||
"documentation":"<p>A complex type that controls whether access logs are written for the distribution.</p> <p>For more information about logging, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html\">Access Logs</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"PriceClass":{
|
||||
"shape":"PriceClass",
|
||||
"documentation":"<p>The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify <code>PriceClass_All</code>, CloudFront responds to requests for your objects from all CloudFront edge locations.</p> <p>If you specify a price class other than <code>PriceClass_All</code>, 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.</p> <p>For more information about price classes, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html\">Choosing the Price Class for a CloudFront Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>. For information about CloudFront pricing, including how price classes map to CloudFront regions, see <a href=\"https://aws.amazon.com/cloudfront/pricing/\">Amazon CloudFront Pricing</a>.</p>"
|
||||
},
|
||||
"Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket.</p> <p>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 <code>false</code> for <code>Enabled</code>, and specify empty <code>Bucket</code> and <code>Prefix</code> elements.</p> <p>If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code> and <code>Prefix</code>, the values are automatically deleted.</p>"
|
||||
},
|
||||
"ViewerCertificate":{"shape":"ViewerCertificate"},
|
||||
"Restrictions":{"shape":"Restrictions"},
|
||||
"WebACLId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.</p> <p>AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html\">AWS WAF Developer Guide</a>. </p>"
|
||||
},
|
||||
"HttpVersion":{
|
||||
"shape":"HttpVersion",
|
||||
"documentation":"<p>(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.</p> <p>For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).</p> <p>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.\" </p>"
|
||||
},
|
||||
"IsIPV6Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify <code>true</code>. If you specify <code>false</code>, CloudFront responds to IPv6 DNS requests with the DNS response code <code>NOERROR</code> and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. </p> <p>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 <code>IpAddress</code> 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 <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html\">Creating a Signed URL Using a Custom Policy</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>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:</p> <ul> <li> <p>You enable IPv6 for the distribution</p> </li> <li> <p>You're using alternate domain names in the URLs for your objects</p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html\">Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A distribution configuration.</p>"
|
||||
},
|
||||
"DistributionConfigWithTags":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DistributionConfig",
|
||||
"Tags"
|
||||
],
|
||||
"members":{
|
||||
"DistributionConfig":{
|
||||
"shape":"DistributionConfig",
|
||||
"documentation":"<p>A distribution configuration.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>A complex type that contains zero or more <code>Tag</code> elements.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A distribution Configuration and a list of tags to be associated with the distribution.</p>"
|
||||
},
|
||||
"DistributionList":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Marker",
|
||||
"MaxItems",
|
||||
"IsTruncated",
|
||||
"Quantity"
|
||||
],
|
||||
"members":{
|
||||
"Marker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value you provided for the <code>Marker</code> request parameter.</p>"
|
||||
},
|
||||
"NextMarker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>If <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value you can use for the <code>Marker</code> request parameter to continue listing your distributions where they left off. </p>"
|
||||
},
|
||||
"MaxItems":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The value you provided for the <code>MaxItems</code> request parameter.</p>"
|
||||
},
|
||||
"IsTruncated":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>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 <code>Marker</code> request parameter to retrieve more distributions in the list.</p>"
|
||||
},
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of distributions that were created by the current AWS account. </p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"DistributionSummaryList",
|
||||
"documentation":"<p>A complex type that contains one <code>DistributionSummary</code> element for each distribution that was created by the current AWS account.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A distribution list.</p>"
|
||||
},
|
||||
"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":"<p>The identifier for the distribution. For example: <code>EDFDVBD632BHDS5</code>.</p>"
|
||||
},
|
||||
"ARN":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The ARN (Amazon Resource Name) for the distribution. For example: <code>arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5</code>, where <code>123456789012</code> is your AWS account ID.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current status of the distribution. When the status is <code>Deployed</code>, the distribution's information is propagated to all CloudFront edge locations.</p>"
|
||||
},
|
||||
"LastModifiedTime":{
|
||||
"shape":"timestamp",
|
||||
"documentation":"<p>The date and time the distribution was last modified.</p>"
|
||||
},
|
||||
"DomainName":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The domain name that corresponds to the distribution. For example: <code>d604721fxaaqy9.cloudfront.net</code>.</p>"
|
||||
},
|
||||
"Aliases":{
|
||||
"shape":"Aliases",
|
||||
"documentation":"<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.</p>"
|
||||
},
|
||||
"Origins":{
|
||||
"shape":"Origins",
|
||||
"documentation":"<p>A complex type that contains information about origins for this distribution.</p>"
|
||||
},
|
||||
"DefaultCacheBehavior":{
|
||||
"shape":"DefaultCacheBehavior",
|
||||
"documentation":"<p>A complex type that describes the default cache behavior if you do not specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>"
|
||||
},
|
||||
"CacheBehaviors":{
|
||||
"shape":"CacheBehaviors",
|
||||
"documentation":"<p>A complex type that contains zero or more <code>CacheBehavior</code> elements.</p>"
|
||||
},
|
||||
"CustomErrorResponses":{
|
||||
"shape":"CustomErrorResponses",
|
||||
"documentation":"<p>A complex type that contains zero or more <code>CustomErrorResponses</code> elements.</p>"
|
||||
},
|
||||
"Comment":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The comment originally specified when this distribution was created.</p>"
|
||||
},
|
||||
"PriceClass":{"shape":"PriceClass"},
|
||||
"Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Whether the distribution is enabled to accept user requests for content.</p>"
|
||||
},
|
||||
"ViewerCertificate":{"shape":"ViewerCertificate"},
|
||||
"Restrictions":{"shape":"Restrictions"},
|
||||
"WebACLId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The Web ACL Id (if any) associated with the distribution.</p>"
|
||||
},
|
||||
"HttpVersion":{
|
||||
"shape":"HttpVersion",
|
||||
"documentation":"<p> Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is <code>http2</code>. Viewers that don't support <code>HTTP/2</code> will automatically use an earlier version.</p>"
|
||||
},
|
||||
"IsIPV6Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A summary of the information about a CloudFront distribution.</p>"
|
||||
},
|
||||
"DistributionSummaryList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"DistributionSummary",
|
||||
"locationName":"DistributionSummary"
|
||||
}
|
||||
},
|
||||
"ForwardedValues":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"QueryString",
|
||||
"Cookies"
|
||||
],
|
||||
"members":{
|
||||
"QueryString":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>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 <code>QueryString</code> and on the values that you specify for <code>QueryStringCacheKeys</code>, if any:</p> <p>If you specify true for <code>QueryString</code> and you don't specify any values for <code>QueryStringCacheKeys</code>, 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.</p> <p>If you specify true for <code>QueryString</code> and you specify one or more values for <code>QueryStringCacheKeys</code>, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.</p> <p>If you specify false for <code>QueryString</code>, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html\">Configuring CloudFront to Cache Based on Query String Parameters</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"Cookies":{
|
||||
"shape":"CookiePreference",
|
||||
"documentation":"<p>A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html\">How CloudFront Forwards, Caches, and Logs Cookies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"Headers":{
|
||||
"shape":"Headers",
|
||||
"documentation":"<p>A complex type that specifies the <code>Headers</code>, if any, that you want CloudFront to vary upon for this cache behavior. </p>"
|
||||
},
|
||||
"QueryStringCacheKeys":{
|
||||
"shape":"QueryStringCacheKeys",
|
||||
"documentation":"<p>A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that specifies how CloudFront handles query strings and cookies.</p>"
|
||||
},
|
||||
"GeoRestriction":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"RestrictionType",
|
||||
"Quantity"
|
||||
],
|
||||
"members":{
|
||||
"RestrictionType":{
|
||||
"shape":"GeoRestrictionType",
|
||||
"documentation":"<p>The method that you want to use to restrict distribution of your content by country:</p> <ul> <li> <p> <code>none</code>: No geo restriction is enabled, meaning access to content is not restricted by client geo location.</p> </li> <li> <p> <code>blacklist</code>: The <code>Location</code> elements specify the countries in which you do not want CloudFront to distribute your content.</p> </li> <li> <p> <code>whitelist</code>: The <code>Location</code> elements specify the countries in which you want CloudFront to distribute your content.</p> </li> </ul>"
|
||||
},
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>When geo restriction is <code>enabled</code>, this is the number of countries in your <code>whitelist</code> or <code>blacklist</code>. Otherwise, when it is not enabled, <code>Quantity</code> is <code>0</code>, and you can omit <code>Items</code>.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"LocationList",
|
||||
"documentation":"<p> A complex type that contains a <code>Location</code> element for each country in which you want CloudFront either to distribute your content (<code>whitelist</code>) or not distribute your content (<code>blacklist</code>).</p> <p>The <code>Location</code> element is a two-letter, uppercase country code for a country that you want to include in your <code>blacklist</code> or <code>whitelist</code>. Include one <code>Location</code> element for each country.</p> <p>CloudFront and <code>MaxMind</code> both use <code>ISO 3166</code> country codes. For the current list of countries and the corresponding codes, see <code>ISO 3166-1-alpha-2</code> code on the <i>International Organization for Standardization</i> website. You can also refer to the country list in the CloudFront console, which includes both country names and codes.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using <code>MaxMind</code> GeoIP databases. </p>"
|
||||
},
|
||||
"GeoRestrictionType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"blacklist",
|
||||
"whitelist",
|
||||
"none"
|
||||
]
|
||||
},
|
||||
"GetCloudFrontOriginAccessIdentityConfigRequest":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The identity's ID. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The origin access identity's configuration information. For more information, see <a>CloudFrontOriginAccessIdentityConfigComplexType</a>.</p>"
|
||||
},
|
||||
"GetCloudFrontOriginAccessIdentityConfigResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CloudFrontOriginAccessIdentityConfig":{
|
||||
"shape":"CloudFrontOriginAccessIdentityConfig",
|
||||
"documentation":"<p>The origin access identity's configuration information. </p>"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"CloudFrontOriginAccessIdentityConfig"
|
||||
},
|
||||
"GetCloudFrontOriginAccessIdentityRequest":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The identity's ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to get an origin access identity's information.</p>"
|
||||
},
|
||||
"GetCloudFrontOriginAccessIdentityResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CloudFrontOriginAccessIdentity":{
|
||||
"shape":"CloudFrontOriginAccessIdentity",
|
||||
"documentation":"<p>The origin access identity's information.</p>"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the origin access identity's information. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"CloudFrontOriginAccessIdentity"
|
||||
},
|
||||
"GetDistributionConfigRequest":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The distribution's ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to get a distribution configuration.</p>"
|
||||
},
|
||||
"GetDistributionConfigResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DistributionConfig":{
|
||||
"shape":"DistributionConfig",
|
||||
"documentation":"<p>The distribution's configuration information.</p>"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"DistributionConfig"
|
||||
},
|
||||
"GetDistributionRequest":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The distribution's ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to get a distribution's information.</p>"
|
||||
},
|
||||
"GetDistributionResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Distribution":{
|
||||
"shape":"Distribution",
|
||||
"documentation":"<p>The distribution's information.</p>"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the distribution's information. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"Distribution"
|
||||
},
|
||||
"GetInvalidationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DistributionId",
|
||||
"Id"
|
||||
],
|
||||
"members":{
|
||||
"DistributionId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The distribution's ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"DistributionId"
|
||||
},
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The identifier for the invalidation request, for example, <code>IDFDVBD632BHDS5</code>.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to get an invalidation's information. </p>"
|
||||
},
|
||||
"GetInvalidationResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Invalidation":{
|
||||
"shape":"Invalidation",
|
||||
"documentation":"<p>The invalidation's information. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/InvalidationDatatype.html\">Invalidation Complex Type</a>. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"Invalidation"
|
||||
},
|
||||
"GetStreamingDistributionConfigRequest":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The streaming distribution's ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>To request to get a streaming distribution configuration.</p>"
|
||||
},
|
||||
"GetStreamingDistributionConfigResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"StreamingDistributionConfig":{
|
||||
"shape":"StreamingDistributionConfig",
|
||||
"documentation":"<p>The streaming distribution's configuration information.</p>"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>. </p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"StreamingDistributionConfig"
|
||||
},
|
||||
"GetStreamingDistributionRequest":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The streaming distribution's ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to get a streaming distribution's information.</p>"
|
||||
},
|
||||
"GetStreamingDistributionResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"StreamingDistribution":{
|
||||
"shape":"StreamingDistribution",
|
||||
"documentation":"<p>The streaming distribution's information.</p>"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the streaming distribution's information. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"StreamingDistribution"
|
||||
},
|
||||
"HeaderList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"string",
|
||||
"locationName":"Name"
|
||||
}
|
||||
},
|
||||
"Headers":{
|
||||
"type":"structure",
|
||||
"required":["Quantity"],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>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:</p> <ul> <li> <p> <b>Forward all headers to your origin</b>: Specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>.</p> <important> <p>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.</p> </important> </li> <li> <p> <i>Forward a whitelist of headers you specify</i>: Specify the number of headers that you want to forward, and specify the header names in <code>Name</code> 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. </p> </li> <li> <p> <b>Forward only the default headers</b>: Specify <code>0</code> for <code>Quantity</code> and omit <code>Items</code>. In this configuration, CloudFront doesn't cache based on the values in the request headers.</p> </li> </ul>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"HeaderList",
|
||||
"documentation":"<p>A complex type that contains one <code>Name</code> element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If <code>Quantity</code> is <code>0</code>, omit <code>Items</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior.</p> <p>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 <code>logo.jpg</code> contain a custom <code>Product</code> header that has a value of either <code>Acme</code> or <code>Apex</code>, and you configure CloudFront to cache your content based on values in the <code>Product</code> header. CloudFront forwards the <code>Product</code> 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 <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html\">How CloudFront Forwards and Caches Headers</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"HttpVersion":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"http1.1",
|
||||
"http2"
|
||||
]
|
||||
},
|
||||
"IllegalUpdate":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>Origin and <code>CallerReference</code> cannot be updated. </p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InconsistentQuantities":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The value of <code>Quantity</code> and the size of <code>Items</code> do not match.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidArgument":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The argument is invalid.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidDefaultRootObject":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The default root object file name is too big or contains an invalid character.</p>",
|
||||
"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":"<p>Your request contains forward cookies option which doesn't match with the expectation for the <code>whitelisted</code> list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.</p>",
|
||||
"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":"<p>The <code>If-Match</code> version is missing or not valid for the distribution.</p>",
|
||||
"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":"<p>The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidOriginAccessIdentity":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The origin access identity is not valid or doesn't exist.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidProtocolSettings":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).</p>",
|
||||
"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":"<p>The relative path is too big, is not URL-encoded, or does not begin with a slash (/).</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidRequiredProtocol":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the <code>RequiredProtocols</code> element from your distribution configuration.</p>",
|
||||
"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":"<p>The identifier for the invalidation request. For example: <code>IDFDVBD632BHDS5</code>.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The status of the invalidation request. When the invalidation batch is finished, the status is <code>Completed</code>.</p>"
|
||||
},
|
||||
"CreateTime":{
|
||||
"shape":"timestamp",
|
||||
"documentation":"<p>The date and time the invalidation request was first made. </p>"
|
||||
},
|
||||
"InvalidationBatch":{
|
||||
"shape":"InvalidationBatch",
|
||||
"documentation":"<p>The current invalidation information for the batch request. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An invalidation. </p>"
|
||||
},
|
||||
"InvalidationBatch":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Paths",
|
||||
"CallerReference"
|
||||
],
|
||||
"members":{
|
||||
"Paths":{
|
||||
"shape":"Paths",
|
||||
"documentation":"<p>A complex type that contains information about the objects that you want to invalidate. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects\">Specifying the Objects to Invalidate</a> in the <i>Amazon CloudFront Developer Guide</i>. </p>"
|
||||
},
|
||||
"CallerReference":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>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 <code>CallerReference</code> and change other values in the request as applicable. One way to ensure that the value of <code>CallerReference</code> is unique is to use a <code>timestamp</code>, for example, <code>20120301090000</code>.</p> <p>If you make a second invalidation request with the same value for <code>CallerReference</code>, 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 <code>CallerReference</code>.</p> <p>If <code>CallerReference</code> is a value you already sent in a previous invalidation batch request but the content of any <code>Path</code> is different from the original request, CloudFront returns an <code>InvalidationBatchAlreadyExists</code> error.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An invalidation batch.</p>"
|
||||
},
|
||||
"InvalidationList":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Marker",
|
||||
"MaxItems",
|
||||
"IsTruncated",
|
||||
"Quantity"
|
||||
],
|
||||
"members":{
|
||||
"Marker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value that you provided for the <code>Marker</code> request parameter.</p>"
|
||||
},
|
||||
"NextMarker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>If <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value that you can use for the <code>Marker</code> request parameter to continue listing your invalidation batches where they left off.</p>"
|
||||
},
|
||||
"MaxItems":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The value that you provided for the <code>MaxItems</code> request parameter.</p>"
|
||||
},
|
||||
"IsTruncated":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>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 <code>Marker</code> request parameter to retrieve more invalidation batches in the list.</p>"
|
||||
},
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of invalidation batches that were created by the current AWS account. </p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"InvalidationSummaryList",
|
||||
"documentation":"<p>A complex type that contains one <code>InvalidationSummary</code> element for each invalidation batch created by the current AWS account.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The <code>InvalidationList</code> complex type describes the list of invalidation objects. For more information about invalidation, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html\">Invalidating Objects (Web Distributions Only)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"InvalidationSummary":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Id",
|
||||
"CreateTime",
|
||||
"Status"
|
||||
],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The unique ID for an invalidation request.</p>"
|
||||
},
|
||||
"CreateTime":{"shape":"timestamp"},
|
||||
"Status":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The status of an invalidation request.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A summary of an invalidation request.</p>"
|
||||
},
|
||||
"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":"<p>The number of active CloudFront key pairs for <code>AwsAccountNumber</code>.</p> <p>For more information, see <a>ActiveTrustedSigners</a>.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"KeyPairIdList",
|
||||
"documentation":"<p>A complex type that lists the active CloudFront key pairs, if any, that are associated with <code>AwsAccountNumber</code>.</p> <p>For more information, see <a>ActiveTrustedSigners</a>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that lists the active CloudFront key pairs, if any, that are associated with <code>AwsAccountNumber</code>. </p> <p>For more information, see <a>ActiveTrustedSigners</a>.</p>"
|
||||
},
|
||||
"ListCloudFrontOriginAccessIdentitiesRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Marker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>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 <code>Marker</code> to the value of the <code>NextMarker</code> from the current page's response (which is also the ID of the last identity on that page).</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"Marker"
|
||||
},
|
||||
"MaxItems":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The maximum number of origin access identities you want in the response body. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"MaxItems"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to list origin access identities. </p>"
|
||||
},
|
||||
"ListCloudFrontOriginAccessIdentitiesResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CloudFrontOriginAccessIdentityList":{
|
||||
"shape":"CloudFrontOriginAccessIdentityList",
|
||||
"documentation":"<p>The <code>CloudFrontOriginAccessIdentityList</code> type. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request. </p>",
|
||||
"payload":"CloudFrontOriginAccessIdentityList"
|
||||
},
|
||||
"ListDistributionsByWebACLIdRequest":{
|
||||
"type":"structure",
|
||||
"required":["WebACLId"],
|
||||
"members":{
|
||||
"Marker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Use <code>Marker</code> and <code>MaxItems</code> to control pagination of results. If you have more than <code>MaxItems</code> distributions that satisfy the request, the response includes a <code>NextMarker</code> element. To get the next page of results, submit another request. For the value of <code>Marker</code>, specify the value of <code>NextMarker</code> from the last response. (For the first request, omit <code>Marker</code>.) </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"Marker"
|
||||
},
|
||||
"MaxItems":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"MaxItems"
|
||||
},
|
||||
"WebACLId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>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. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"WebACLId"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to list distributions that are associated with a specified AWS WAF web ACL. </p>"
|
||||
},
|
||||
"ListDistributionsByWebACLIdResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DistributionList":{
|
||||
"shape":"DistributionList",
|
||||
"documentation":"<p>The <code>DistributionList</code> type. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The response to a request to list the distributions that are associated with a specified AWS WAF web ACL. </p>",
|
||||
"payload":"DistributionList"
|
||||
},
|
||||
"ListDistributionsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Marker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>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 <code>Marker</code> to the value of the <code>NextMarker</code> from the current page's response (which is also the ID of the last distribution on that page).</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"Marker"
|
||||
},
|
||||
"MaxItems":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The maximum number of distributions you want in the response body.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"MaxItems"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to list your distributions. </p>"
|
||||
},
|
||||
"ListDistributionsResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DistributionList":{
|
||||
"shape":"DistributionList",
|
||||
"documentation":"<p>The <code>DistributionList</code> type. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request. </p>",
|
||||
"payload":"DistributionList"
|
||||
},
|
||||
"ListInvalidationsRequest":{
|
||||
"type":"structure",
|
||||
"required":["DistributionId"],
|
||||
"members":{
|
||||
"DistributionId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The distribution's ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"DistributionId"
|
||||
},
|
||||
"Marker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>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 <code>Marker</code> to the value of the <code>NextMarker</code> from the current page's response. This value is the same as the ID of the last invalidation batch on that page. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"Marker"
|
||||
},
|
||||
"MaxItems":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The maximum number of invalidation batches that you want in the response body.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"MaxItems"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to list invalidations. </p>"
|
||||
},
|
||||
"ListInvalidationsResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"InvalidationList":{
|
||||
"shape":"InvalidationList",
|
||||
"documentation":"<p>Information about invalidation batches. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request. </p>",
|
||||
"payload":"InvalidationList"
|
||||
},
|
||||
"ListStreamingDistributionsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Marker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value that you provided for the <code>Marker</code> request parameter.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"Marker"
|
||||
},
|
||||
"MaxItems":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value that you provided for the <code>MaxItems</code> request parameter.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"MaxItems"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to list your streaming distributions. </p>"
|
||||
},
|
||||
"ListStreamingDistributionsResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"StreamingDistributionList":{
|
||||
"shape":"StreamingDistributionList",
|
||||
"documentation":"<p>The <code>StreamingDistributionList</code> type. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request. </p>",
|
||||
"payload":"StreamingDistributionList"
|
||||
},
|
||||
"ListTagsForResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":["Resource"],
|
||||
"members":{
|
||||
"Resource":{
|
||||
"shape":"ResourceARN",
|
||||
"documentation":"<p> An ARN of a CloudFront resource.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"Resource"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> The request to list tags for a CloudFront resource.</p>"
|
||||
},
|
||||
"ListTagsForResourceResult":{
|
||||
"type":"structure",
|
||||
"required":["Tags"],
|
||||
"members":{
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p> A complex type that contains zero or more <code>Tag</code> elements.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> The returned result of the corresponding request.</p>",
|
||||
"payload":"Tags"
|
||||
},
|
||||
"LocationList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"string",
|
||||
"locationName":"Location"
|
||||
}
|
||||
},
|
||||
"LoggingConfig":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Enabled",
|
||||
"IncludeCookies",
|
||||
"Bucket",
|
||||
"Prefix"
|
||||
],
|
||||
"members":{
|
||||
"Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>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 <code>false</code> for <code>Enabled</code>, and specify empty <code>Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code>, <code>prefix</code>, and <code>IncludeCookies</code>, the values are automatically deleted.</p>"
|
||||
},
|
||||
"IncludeCookies":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Specifies whether you want CloudFront to include cookies in access logs, specify <code>true</code> for <code>IncludeCookies</code>. 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 <code>false</code> for <code>IncludeCookies</code>.</p>"
|
||||
},
|
||||
"Bucket":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The Amazon S3 bucket to store the access logs in, for example, <code>myawslogbucket.s3.amazonaws.com</code>.</p>"
|
||||
},
|
||||
"Prefix":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>An optional string that you want CloudFront to prefix to the access log <code>filenames</code> for this distribution, for example, <code>myprefix/</code>. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> element.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that controls whether access logs are written for the distribution.</p>"
|
||||
},
|
||||
"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":"<p>This operation requires a body. Ensure that the body is present and the Content-Type header is set.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"NoSuchCloudFrontOriginAccessIdentity":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The specified origin access identity does not exist.</p>",
|
||||
"error":{"httpStatusCode":404},
|
||||
"exception":true
|
||||
},
|
||||
"NoSuchDistribution":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The specified distribution does not exist.</p>",
|
||||
"error":{"httpStatusCode":404},
|
||||
"exception":true
|
||||
},
|
||||
"NoSuchInvalidation":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The specified invalidation does not exist.</p>",
|
||||
"error":{"httpStatusCode":404},
|
||||
"exception":true
|
||||
},
|
||||
"NoSuchOrigin":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>No origin exists with the specified <code>Origin Id</code>. </p>",
|
||||
"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":"<p>The specified streaming distribution does not exist.</p>",
|
||||
"error":{"httpStatusCode":404},
|
||||
"exception":true
|
||||
},
|
||||
"Origin":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Id",
|
||||
"DomainName"
|
||||
],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>A unique identifier for the origin. The value of <code>Id</code> must be unique within the distribution.</p> <p>When you specify the value of <code>TargetOriginId</code> 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 <code>Id</code> 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 <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior\">Cache Behavior Settings</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"DomainName":{
|
||||
"shape":"string",
|
||||
"documentation":"<p> <b>Amazon S3 origins</b>: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, <code>myawsbucket.s3.amazonaws.com</code>.</p> <p>Constraints for Amazon S3 origins: </p> <ul> <li> <p>If you configured Amazon S3 Transfer Acceleration for your bucket, do not specify the <code>s3-accelerate</code> endpoint for <code>DomainName</code>.</p> </li> <li> <p>The bucket name must be between 3 and 63 characters long (inclusive).</p> </li> <li> <p>The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.</p> </li> <li> <p>The bucket name must not contain adjacent periods.</p> </li> </ul> <p> <b>Custom Origins</b>: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, <code>www.example.com</code>. </p> <p>Constraints for custom origins:</p> <ul> <li> <p> <code>DomainName</code> must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.</p> </li> <li> <p>The name cannot exceed 128 characters.</p> </li> </ul>"
|
||||
},
|
||||
"OriginPath":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>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 <code>OriginPath</code> element, specify the directory name, beginning with a <code>/</code>. CloudFront appends the directory name to the value of <code>DomainName</code>, for example, <code>example.com/production</code>. Do not include a <code>/</code> at the end of the directory name.</p> <p>For example, suppose you've specified the following values for your distribution:</p> <ul> <li> <p> <code>DomainName</code>: An Amazon S3 bucket named <code>myawsbucket</code>.</p> </li> <li> <p> <code>OriginPath</code>: <code>/production</code> </p> </li> <li> <p> <code>CNAME</code>: <code>example.com</code> </p> </li> </ul> <p>When a user enters <code>example.com/index.html</code> in a browser, CloudFront sends a request to Amazon S3 for <code>myawsbucket/production/index.html</code>.</p> <p>When a user enters <code>example.com/acme/index.html</code> in a browser, CloudFront sends a request to Amazon S3 for <code>myawsbucket/production/acme/index.html</code>.</p>"
|
||||
},
|
||||
"CustomHeaders":{
|
||||
"shape":"CustomHeaders",
|
||||
"documentation":"<p>A complex type that contains names and values for the custom headers that you want.</p>"
|
||||
},
|
||||
"S3OriginConfig":{
|
||||
"shape":"S3OriginConfig",
|
||||
"documentation":"<p>A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the <code>CustomOriginConfig</code> element instead.</p>"
|
||||
},
|
||||
"CustomOriginConfig":{
|
||||
"shape":"CustomOriginConfig",
|
||||
"documentation":"<p>A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the <code>S3OriginConfig</code> element instead.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>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.</p> <p>For the current limit on the number of origins that you can create for a distribution, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_cloudfront\">Amazon CloudFront Limits</a> in the <i>AWS General Reference</i>.</p>"
|
||||
},
|
||||
"OriginCustomHeader":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"HeaderName",
|
||||
"HeaderValue"
|
||||
],
|
||||
"members":{
|
||||
"HeaderName":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The name of a header that you want CloudFront to forward to your origin. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html\">Forwarding Custom Headers to Your Origin (Web Distributions Only)</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"HeaderValue":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value for the header that you specified in the <code>HeaderName</code> field.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that contains <code>HeaderName</code> and <code>HeaderValue</code> elements, if any, for this distribution. </p>"
|
||||
},
|
||||
"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":"<p>The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin. </p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"SslProtocolsList",
|
||||
"documentation":"<p>A list that contains allowed SSL/TLS protocols for this distribution.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin. </p>"
|
||||
},
|
||||
"Origins":{
|
||||
"type":"structure",
|
||||
"required":["Quantity"],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of origins for this distribution.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"OriginList",
|
||||
"documentation":"<p>A complex type that contains origins for this distribution.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that contains information about origins for this distribution. </p>"
|
||||
},
|
||||
"PathList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"string",
|
||||
"locationName":"Path"
|
||||
}
|
||||
},
|
||||
"Paths":{
|
||||
"type":"structure",
|
||||
"required":["Quantity"],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of objects that you want to invalidate.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"PathList",
|
||||
"documentation":"<p>A complex type that contains a list of the paths that you want to invalidate.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that contains information about the objects that you want to invalidate. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects\">Specifying the Objects to Invalidate</a> in the <i>Amazon CloudFront Developer Guide</i>. </p>"
|
||||
},
|
||||
"PreconditionFailed":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The precondition given in one or more of the request-header fields evaluated to <code>false</code>. </p>",
|
||||
"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":"<p>The number of <code>whitelisted</code> query string parameters for this cache behavior.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"QueryStringCacheKeysList",
|
||||
"documentation":"<p>(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 <code>Quantity</code> is 0, you can omit <code>Items</code>. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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":"<p>A complex type that identifies ways in which you want to restrict distribution of your content.</p>"
|
||||
},
|
||||
"S3Origin":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DomainName",
|
||||
"OriginAccessIdentity"
|
||||
],
|
||||
"members":{
|
||||
"DomainName":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The DNS name of the Amazon S3 origin. </p>"
|
||||
},
|
||||
"OriginAccessIdentity":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>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.</p> <p>If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty <code>OriginAccessIdentity</code> element.</p> <p>To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty <code>OriginAccessIdentity</code> element.</p> <p>To replace the origin access identity, update the distribution configuration and specify the new origin access identity.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html\">Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.</p>"
|
||||
},
|
||||
"S3OriginConfig":{
|
||||
"type":"structure",
|
||||
"required":["OriginAccessIdentity"],
|
||||
"members":{
|
||||
"OriginAccessIdentity":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can <i>only</i> access objects in an Amazon S3 bucket through CloudFront. The format of the value is:</p> <p>origin-access-identity/CloudFront/<i>ID-of-origin-access-identity</i> </p> <p>where <code> <i>ID-of-origin-access-identity</i> </code> is the value that CloudFront returned in the <code>ID</code> element when you created the origin access identity.</p> <p>If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty <code>OriginAccessIdentity</code> element.</p> <p>To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty <code>OriginAccessIdentity</code> element.</p> <p>To replace the origin access identity, update the distribution configuration and specify the new origin access identity.</p> <p>For more information about the origin access identity, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the <code>CustomOriginConfig</code> element instead.</p>"
|
||||
},
|
||||
"SSLSupportMethod":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"sni-only",
|
||||
"vip"
|
||||
]
|
||||
},
|
||||
"Signer":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AwsAccountNumber":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>An AWS account that is included in the <code>TrustedSigners</code> complex type for this RTMP distribution. Valid values include:</p> <ul> <li> <p> <code>self</code>, which is the AWS account used to create the distribution.</p> </li> <li> <p>An AWS account number.</p> </li> </ul>"
|
||||
},
|
||||
"KeyPairIds":{
|
||||
"shape":"KeyPairIds",
|
||||
"documentation":"<p>A complex type that lists the active CloudFront key pairs, if any, that are associated with <code>AwsAccountNumber</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that lists the AWS accounts that were included in the <code>TrustedSigners</code> complex type, as well as their active CloudFront key pair IDs, if any. </p>"
|
||||
},
|
||||
"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":"<p>The identifier for the RTMP distribution. For example: <code>EGTXBD79EXAMPLE</code>.</p>"
|
||||
},
|
||||
"ARN":{"shape":"string"},
|
||||
"Status":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current status of the RTMP distribution. When the status is <code>Deployed</code>, the distribution's information is propagated to all CloudFront edge locations.</p>"
|
||||
},
|
||||
"LastModifiedTime":{
|
||||
"shape":"timestamp",
|
||||
"documentation":"<p>The date and time that the distribution was last modified. </p>"
|
||||
},
|
||||
"DomainName":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The domain name that corresponds to the streaming distribution. For example: <code>s5c39gqb8ow64r.cloudfront.net</code>. </p>"
|
||||
},
|
||||
"ActiveTrustedSigners":{
|
||||
"shape":"ActiveTrustedSigners",
|
||||
"documentation":"<p>A complex type that lists the AWS accounts, if any, that you included in the <code>TrustedSigners</code> complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.</p> <p>The <code>Signer</code> complex type lists the AWS account number of the trusted signer or <code>self</code> if the signer is the AWS account that created the distribution. The <code>Signer</code> element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no <code>KeyPairId</code> element appears for a <code>Signer</code>, that signer can't create signed URLs.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>. </p>"
|
||||
},
|
||||
"StreamingDistributionConfig":{
|
||||
"shape":"StreamingDistributionConfig",
|
||||
"documentation":"<p>The current configuration information for the RTMP distribution.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A streaming distribution. </p>"
|
||||
},
|
||||
"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":"<p>A unique number that ensures that the request can't be replayed. If the <code>CallerReference</code> is new (no matter the content of the <code>StreamingDistributionConfig</code> object), a new streaming distribution is created. If the <code>CallerReference</code> is a value that you already sent in a previous request to create a streaming distribution, and the content of the <code>StreamingDistributionConfig</code> is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the <code>CallerReference</code> is a value that you already sent in a previous request to create a streaming distribution but the content of the <code>StreamingDistributionConfig</code> is different from the original request, CloudFront returns a <code>DistributionAlreadyExists</code> error. </p>"
|
||||
},
|
||||
"S3Origin":{
|
||||
"shape":"S3Origin",
|
||||
"documentation":"<p>A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution. </p>"
|
||||
},
|
||||
"Aliases":{
|
||||
"shape":"Aliases",
|
||||
"documentation":"<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution. </p>"
|
||||
},
|
||||
"Comment":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Any comments you want to include about the streaming distribution. </p>"
|
||||
},
|
||||
"Logging":{
|
||||
"shape":"StreamingLoggingConfig",
|
||||
"documentation":"<p>A complex type that controls whether access logs are written for the streaming distribution. </p>"
|
||||
},
|
||||
"TrustedSigners":{
|
||||
"shape":"TrustedSigners",
|
||||
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>. </p>"
|
||||
},
|
||||
"PriceClass":{
|
||||
"shape":"PriceClass",
|
||||
"documentation":"<p>A complex type that contains information about price class for this streaming distribution. </p>"
|
||||
},
|
||||
"Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Whether the streaming distribution is enabled to accept user requests for content.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The RTMP distribution's configuration information.</p>"
|
||||
},
|
||||
"StreamingDistributionConfigWithTags":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"StreamingDistributionConfig",
|
||||
"Tags"
|
||||
],
|
||||
"members":{
|
||||
"StreamingDistributionConfig":{
|
||||
"shape":"StreamingDistributionConfig",
|
||||
"documentation":"<p>A streaming distribution Configuration.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>A complex type that contains zero or more <code>Tag</code> elements.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A streaming distribution Configuration and a list of tags to be associated with the streaming distribution.</p>"
|
||||
},
|
||||
"StreamingDistributionList":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Marker",
|
||||
"MaxItems",
|
||||
"IsTruncated",
|
||||
"Quantity"
|
||||
],
|
||||
"members":{
|
||||
"Marker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value you provided for the <code>Marker</code> request parameter. </p>"
|
||||
},
|
||||
"NextMarker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>If <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value you can use for the <code>Marker</code> request parameter to continue listing your RTMP distributions where they left off. </p>"
|
||||
},
|
||||
"MaxItems":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The value you provided for the <code>MaxItems</code> request parameter. </p>"
|
||||
},
|
||||
"IsTruncated":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>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 <code>Marker</code> request parameter to retrieve more distributions in the list. </p>"
|
||||
},
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of streaming distributions that were created by the current AWS account. </p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"StreamingDistributionSummaryList",
|
||||
"documentation":"<p>A complex type that contains one <code>StreamingDistributionSummary</code> element for each distribution that was created by the current AWS account.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A streaming distribution list. </p>"
|
||||
},
|
||||
"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":"<p>The identifier for the distribution. For example: <code>EDFDVBD632BHDS5</code>.</p>"
|
||||
},
|
||||
"ARN":{
|
||||
"shape":"string",
|
||||
"documentation":"<p> The ARN (Amazon Resource Name) for the streaming distribution. For example: <code>arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5</code>, where <code>123456789012</code> is your AWS account ID.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"string",
|
||||
"documentation":"<p> Indicates the current status of the distribution. When the status is <code>Deployed</code>, the distribution's information is fully propagated throughout the Amazon CloudFront system.</p>"
|
||||
},
|
||||
"LastModifiedTime":{
|
||||
"shape":"timestamp",
|
||||
"documentation":"<p>The date and time the distribution was last modified.</p>"
|
||||
},
|
||||
"DomainName":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The domain name corresponding to the distribution. For example: <code>d604721fxaaqy9.cloudfront.net</code>.</p>"
|
||||
},
|
||||
"S3Origin":{
|
||||
"shape":"S3Origin",
|
||||
"documentation":"<p>A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.</p>"
|
||||
},
|
||||
"Aliases":{
|
||||
"shape":"Aliases",
|
||||
"documentation":"<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.</p>"
|
||||
},
|
||||
"TrustedSigners":{
|
||||
"shape":"TrustedSigners",
|
||||
"documentation":"<p>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 <code>PathPattern</code> for this cache behavior, specify <code>true</code> for <code>Enabled</code>, and specify the applicable values for <code>Quantity</code> and <code>Items</code>.If you don't want to require signed URLs in requests for objects that match <code>PathPattern</code>, specify <code>false</code> for <code>Enabled</code> and <code>0</code> for <code>Quantity</code>. Omit <code>Items</code>. To add, change, or remove one or more trusted signers, change <code>Enabled</code> to <code>true</code> (if it's currently <code>false</code>), change <code>Quantity</code> as applicable, and specify all of the trusted signers that you want to include in the updated distribution.</p>"
|
||||
},
|
||||
"Comment":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The comment originally specified when this distribution was created.</p>"
|
||||
},
|
||||
"PriceClass":{"shape":"PriceClass"},
|
||||
"Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Whether the distribution is enabled to accept end user requests for content.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> A summary of the information for an Amazon CloudFront streaming distribution.</p>"
|
||||
},
|
||||
"StreamingDistributionSummaryList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"StreamingDistributionSummary",
|
||||
"locationName":"StreamingDistributionSummary"
|
||||
}
|
||||
},
|
||||
"StreamingLoggingConfig":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Enabled",
|
||||
"Bucket",
|
||||
"Prefix"
|
||||
],
|
||||
"members":{
|
||||
"Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>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 <code>false</code> for <code>Enabled</code>, and specify <code>empty Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code> and <code>Prefix</code>, the values are automatically deleted. </p>"
|
||||
},
|
||||
"Bucket":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The Amazon S3 bucket to store the access logs in, for example, <code>myawslogbucket.s3.amazonaws.com</code>.</p>"
|
||||
},
|
||||
"Prefix":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>An optional string that you want CloudFront to prefix to the access log <code>filenames</code> for this streaming distribution, for example, <code>myprefix/</code>. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> element.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that controls whether access logs are written for this streaming distribution.</p>"
|
||||
},
|
||||
"Tag":{
|
||||
"type":"structure",
|
||||
"required":["Key"],
|
||||
"members":{
|
||||
"Key":{
|
||||
"shape":"TagKey",
|
||||
"documentation":"<p> A string that contains <code>Tag</code> key.</p> <p>The string length should be between 1 and 128 characters. Valid characters include <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, space, and the special characters <code>_ - . : / = + @</code>.</p>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"TagValue",
|
||||
"documentation":"<p> A string that contains an optional <code>Tag</code> value.</p> <p>The string length should be between 0 and 256 characters. Valid characters include <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, space, and the special characters <code>_ - . : / = + @</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> A complex type that contains <code>Tag</code> key and <code>Tag</code> value.</p>"
|
||||
},
|
||||
"TagKey":{
|
||||
"type":"string",
|
||||
"documentation":"<p> A string that contains <code>Tag</code> key.</p> <p>The string length should be between 1 and 128 characters. Valid characters include <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, space, and the special characters <code>_ - . : / = + @</code>.</p>",
|
||||
"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":"<p> A complex type that contains <code>Tag</code> key elements.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> A complex type that contains zero or more <code>Tag</code> elements.</p>"
|
||||
},
|
||||
"TagList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"Tag",
|
||||
"locationName":"Tag"
|
||||
}
|
||||
},
|
||||
"TagResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Resource",
|
||||
"Tags"
|
||||
],
|
||||
"members":{
|
||||
"Resource":{
|
||||
"shape":"ResourceARN",
|
||||
"documentation":"<p> An ARN of a CloudFront resource.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"Resource"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p> A complex type that contains zero or more <code>Tag</code> elements.</p>",
|
||||
"locationName":"Tags",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"}
|
||||
}
|
||||
},
|
||||
"documentation":"<p> The request to add tags to a CloudFront resource.</p>",
|
||||
"payload":"Tags"
|
||||
},
|
||||
"TagValue":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":0,
|
||||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
|
||||
},
|
||||
"Tags":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Items":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p> A complex type that contains <code>Tag</code> elements.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> A complex type that contains zero or more <code>Tag</code> elements.</p>"
|
||||
},
|
||||
"TooManyCacheBehaviors":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>You cannot create more cache behaviors for the distribution.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyCertificates":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>You cannot create anymore custom SSL/TLS certificates.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyCloudFrontOriginAccessIdentities":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>Processing your request would cause you to exceed the maximum number of origin access identities allowed.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyCookieNamesInWhiteList":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>Your request contains more cookie names in the whitelist than are allowed per cache behavior.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyDistributionCNAMEs":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>Your request contains more CNAMEs than are allowed per distribution.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyDistributions":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>Processing your request would cause you to exceed the maximum number of distributions allowed.</p>",
|
||||
"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":"<p>You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.</p>",
|
||||
"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":"<p>You cannot create more origins for the distribution.</p>",
|
||||
"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":"<p>Processing your request would cause you to exceed the maximum number of streaming distributions allowed.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyTrustedSigners":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>Your request contains more trusted signers than are allowed per distribution.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TrustedSignerDoesNotExist":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>One or more of your trusted signers do not exist.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TrustedSigners":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Enabled",
|
||||
"Quantity"
|
||||
],
|
||||
"members":{
|
||||
"Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Specifies whether you want to require viewers to use signed URLs to access the files specified by <code>PathPattern</code> and <code>TargetOriginId</code>.</p>"
|
||||
},
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of trusted signers for this cache behavior.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"AwsAccountNumberList",
|
||||
"documentation":"<p> <b>Optional</b>: A complex type that contains trusted signers for this cache behavior. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.</p> <p>If you want to require signed URLs in requests for objects in the target origin that match the <code>PathPattern</code> for this cache behavior, specify <code>true</code> for <code>Enabled</code>, and specify the applicable values for <code>Quantity</code> and <code>Items</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p> <p>If you don't want to require signed URLs in requests for objects that match <code>PathPattern</code>, specify <code>false</code> for <code>Enabled</code> and <code>0</code> for <code>Quantity</code>. Omit <code>Items</code>.</p> <p>To add, change, or remove one or more trusted signers, change <code>Enabled</code> to <code>true</code> (if it's currently <code>false</code>), change <code>Quantity</code> as applicable, and specify all of the trusted signers that you want to include in the updated distribution.</p> <p>For more information about updating the distribution configuration, see <a>DistributionConfig</a> .</p>"
|
||||
},
|
||||
"UntagResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Resource",
|
||||
"TagKeys"
|
||||
],
|
||||
"members":{
|
||||
"Resource":{
|
||||
"shape":"ResourceARN",
|
||||
"documentation":"<p> An ARN of a CloudFront resource.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"Resource"
|
||||
},
|
||||
"TagKeys":{
|
||||
"shape":"TagKeys",
|
||||
"documentation":"<p> A complex type that contains zero or more <code>Tag</code> key elements.</p>",
|
||||
"locationName":"TagKeys",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"}
|
||||
}
|
||||
},
|
||||
"documentation":"<p> The request to remove tags from a CloudFront resource.</p>",
|
||||
"payload":"TagKeys"
|
||||
},
|
||||
"UpdateCloudFrontOriginAccessIdentityRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"CloudFrontOriginAccessIdentityConfig",
|
||||
"Id"
|
||||
],
|
||||
"members":{
|
||||
"CloudFrontOriginAccessIdentityConfig":{
|
||||
"shape":"CloudFrontOriginAccessIdentityConfig",
|
||||
"documentation":"<p>The identity's configuration information.</p>",
|
||||
"locationName":"CloudFrontOriginAccessIdentityConfig",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"}
|
||||
},
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The identity's id.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
},
|
||||
"IfMatch":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value of the <code>ETag</code> header that you received when retrieving the identity's configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"If-Match"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to update an origin access identity.</p>",
|
||||
"payload":"CloudFrontOriginAccessIdentityConfig"
|
||||
},
|
||||
"UpdateCloudFrontOriginAccessIdentityResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CloudFrontOriginAccessIdentity":{
|
||||
"shape":"CloudFrontOriginAccessIdentity",
|
||||
"documentation":"<p>The origin access identity's information.</p>"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"CloudFrontOriginAccessIdentity"
|
||||
},
|
||||
"UpdateDistributionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DistributionConfig",
|
||||
"Id"
|
||||
],
|
||||
"members":{
|
||||
"DistributionConfig":{
|
||||
"shape":"DistributionConfig",
|
||||
"documentation":"<p>The distribution's configuration information.</p>",
|
||||
"locationName":"DistributionConfig",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"}
|
||||
},
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The distribution's id.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
},
|
||||
"IfMatch":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value of the <code>ETag</code> header that you received when retrieving the distribution's configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"If-Match"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to update a distribution.</p>",
|
||||
"payload":"DistributionConfig"
|
||||
},
|
||||
"UpdateDistributionResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Distribution":{
|
||||
"shape":"Distribution",
|
||||
"documentation":"<p>The distribution's information.</p>"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"Distribution"
|
||||
},
|
||||
"UpdateStreamingDistributionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"StreamingDistributionConfig",
|
||||
"Id"
|
||||
],
|
||||
"members":{
|
||||
"StreamingDistributionConfig":{
|
||||
"shape":"StreamingDistributionConfig",
|
||||
"documentation":"<p>The streaming distribution's configuration information.</p>",
|
||||
"locationName":"StreamingDistributionConfig",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"}
|
||||
},
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The streaming distribution's id.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
},
|
||||
"IfMatch":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value of the <code>ETag</code> header that you received when retrieving the streaming distribution's configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"If-Match"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to update a streaming distribution.</p>",
|
||||
"payload":"StreamingDistributionConfig"
|
||||
},
|
||||
"UpdateStreamingDistributionResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"StreamingDistribution":{
|
||||
"shape":"StreamingDistribution",
|
||||
"documentation":"<p>The streaming distribution's information.</p>"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"StreamingDistribution"
|
||||
},
|
||||
"ViewerCertificate":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CloudFrontDefaultCertificate":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>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, <code>https://d111111abcdef8.cloudfront.net/logo.jpg</code>), set to <code>true</code>. Omit this value if you are setting an <code>ACMCertificateArn</code> or <code>IAMCertificateId</code>.</p>"
|
||||
},
|
||||
"IAMCertificateId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>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, <code>https://example.com/logo.jpg)</code>, specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value, <code>ACMCertificateArn</code>, or <code>CloudFrontDefaultCertificate</code>.</p>"
|
||||
},
|
||||
"ACMCertificateArn":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, <code>https://example.com/logo.jpg)</code>, specify the ACM certificate ARN of the custom viewer certificate for this distribution. Specify either this value, <code>IAMCertificateId</code>, or <code>CloudFrontDefaultCertificate</code>.</p>"
|
||||
},
|
||||
"SSLSupportMethod":{
|
||||
"shape":"SSLSupportMethod",
|
||||
"documentation":"<p>If you specify a value for <code>ACMCertificateArn</code> or for <code>IAMCertificateId</code>, 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:</p> <ul> <li> <p> <code>vip</code>: 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.</p> </li> <li> <p> <code>sni-only</code>: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but 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:</p> <ul> <li> <p>Use the <code>vip</code> option (dedicated IP addresses) instead of <code>sni-only</code>.</p> </li> <li> <p>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, <code>https://d111111abcdef8.cloudfront.net/logo.png</code>.</p> </li> <li> <p>If you can control which browser your users use, upgrade the browser to one that supports SNI.</p> </li> <li> <p>Use HTTP instead of HTTPS.</p> </li> </ul> </li> </ul> <p>Do not specify a value for <code>SSLSupportMethod</code> if you specified <code><CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate></code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html#CNAMEsAndHTTPS.html\">Using Alternate Domain Names and HTTPS</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"MinimumProtocolVersion":{
|
||||
"shape":"MinimumProtocolVersion",
|
||||
"documentation":"<p>Specify the minimum version of the SSL/TLS protocol that you want CloudFront to use for HTTPS connections between viewers and CloudFront: <code>SSLv3</code> or <code>TLSv1</code>. CloudFront serves your objects only to viewers that support SSL/TLS version that you specify and later versions. The <code>TLSv1</code> protocol is more secure, so we recommend that you specify <code>SSLv3</code> only if your users are using browsers or devices that don't support <code>TLSv1</code>. Note the following:</p> <ul> <li> <p>If you specify <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>, the minimum SSL protocol version is <code>TLSv1</code> and can't be changed.</p> </li> <li> <p>If you're using a custom certificate (if you specify a value for <code>ACMCertificateArn</code> or for <code>IAMCertificateId</code>) and if you're using SNI (if you specify <code>sni-only</code> for <code>SSLSupportMethod</code>), you must specify <code>TLSv1</code> for <code>MinimumProtocolVersion</code>.</p> </li> </ul>"
|
||||
},
|
||||
"Certificate":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Include one of these values to specify the following:</p> <ul> <li> <p>Whether you want viewers to use HTTP or HTTPS to request your objects.</p> </li> <li> <p>If you want viewers to use HTTPS, whether you're using an alternate domain name such as example.com or the CloudFront domain name for your distribution, such as <code>d111111abcdef8.cloudfront.net</code>.</p> </li> <li> <p>If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.</p> </li> </ul> <p>You must specify one (and only one) of the three values. Do not specify <code>false</code> for <code>CloudFrontDefaultCertificate</code>.</p> <p> <b>If you want viewers to use HTTP to request your objects</b>: Specify the following value:</p> <p> <code><CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate></code> </p> <p>In addition, specify <code>allow-all</code> for <code>ViewerProtocolPolicy</code> for all of your cache behaviors.</p> <p> <b>If you want viewers to use HTTPS to request your objects</b>: 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:</p> <ul> <li> <p> <b>If you're using an alternate domain name, such as example.com</b>: Specify one of the following values, depending on whether ACM provided your certificate or you purchased your certificate from third-party certificate authority:</p> <ul> <li> <p> <code><ACMCertificateArn>ARN for ACM SSL/TLS certificate<ACMCertificateArn></code> where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.</p> </li> <li> <p> <code><IAMCertificateId>IAM certificate ID<IAMCertificateId></code> where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store.</p> </li> </ul> <p>If you specify <code>ACMCertificateArn</code> or <code>IAMCertificateId</code>, you must also specify a value for <code>SSLSupportMethod</code>.</p> <p>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 (<code>https://example.com/logo.jpg</code>). If you use the domain name that is associated with your CloudFront distribution (<code>https://d111111abcdef8.cloudfront.net/logo.jpg</code>) and the viewer supports <code>SNI</code>, then CloudFront behaves normally. However, if the browser does not support SNI, the user's experience depends on the value that you choose for <code>SSLSupportMethod</code>:</p> <ul> <li> <p> <code>vip</code>: The viewer displays a warning because there is a mismatch between the CloudFront domain name and the domain name in your SSL/TLS certificate.</p> </li> <li> <p> <code>sni-only</code>: CloudFront drops the connection with the browser without returning the object.</p> </li> </ul> </li> <li> <p> <b>If you're using the CloudFront domain name for your distribution, such as <code>d111111abcdef8.cloudfront.net</code> </b>: Specify the following value:</p> <p> <code> <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate> </code> </p> <p>If you want viewers to use HTTPS, you must also specify one of the following values in your cache behaviors:</p> <ul> <li> <p> <code> <ViewerProtocolPolicy>https-only<ViewerProtocolPolicy> </code> </p> </li> <li> <p> <code> <ViewerProtocolPolicy>redirect-to-https<ViewerProtocolPolicy> </code> </p> </li> </ul> <p>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:</p> <ul> <li> <p> <code> <OriginProtocolPolicy>https-only<OriginProtocolPolicy> </code> </p> </li> <li> <p> <code> <OriginProtocolPolicy>match-viewer<OriginProtocolPolicy> </code> </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html#CNAMEsAndHTTPS\">Using Alternate Domain Names and HTTPS</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </li> </ul>",
|
||||
"deprecated":true
|
||||
},
|
||||
"CertificateSource":{
|
||||
"shape":"CertificateSource",
|
||||
"documentation":"<note> <p>This field is deprecated. You can use one of the following: <code>[ACMCertificateArn</code>, <code>IAMCertificateId</code>, or <code>CloudFrontDefaultCertificate]</code>.</p> </note>",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that specifies the following:</p> <ul> <li> <p>Which SSL/TLS certificate to use when viewers request objects using HTTPS</p> </li> <li> <p>Whether you want CloudFront to use dedicated IP addresses or SNI when you're using alternate domain names in your object names</p> </li> <li> <p>The minimum protocol version that you want CloudFront to use when communicating with viewers</p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html\">Using an HTTPS Connection to Access Your Objects</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"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":"<fullname>Amazon CloudFront</fullname> <p>This is the <i>Amazon CloudFront API Reference</i>. 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 <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
}
|
||||
47
botocore/data/cloudfront/2016-09-29/waiters-2.json
Normal file
47
botocore/data/cloudfront/2016-09-29/waiters-2.json
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
{
|
||||
"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"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
144
botocore/data/config/2014-11-12/service-2.json
Normal file → Executable file
144
botocore/data/config/2014-11-12/service-2.json
Normal file → Executable file
|
|
@ -76,7 +76,7 @@
|
|||
{"shape":"NoAvailableConfigurationRecorderException"},
|
||||
{"shape":"NoRunningConfigurationRecorderException"}
|
||||
],
|
||||
"documentation":"<p>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.</p> <ul> <li>Notification of starting the delivery.</li> <li>Notification of delivery completed, if the delivery was successfully completed.</li> <li>Notification of delivery failure, if the delivery failed to complete.</li> </ul>"
|
||||
"documentation":"<p>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.</p> <ul> <li> <p>Notification of starting the delivery.</p> </li> <li> <p>Notification of delivery completed, if the delivery was successfully completed.</p> </li> <li> <p>Notification of delivery failure, if the delivery failed to complete.</p> </li> </ul>"
|
||||
},
|
||||
"DescribeComplianceByConfigRule":{
|
||||
"name":"DescribeComplianceByConfigRule",
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"NoSuchConfigRuleException"}
|
||||
],
|
||||
"documentation":"<p>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.</p> <p>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. </p> <p>If AWS Config has no current evaluation results for the rule, it returns <code>INSUFFICIENT_DATA</code>. This result might indicate one of the following conditions:</p> <ul> <li>AWS Config has never invoked an evaluation for the rule. To check whether it has, use the <code>DescribeConfigRuleEvaluationStatus</code> action to get the <code>LastSuccessfulInvocationTime</code> and <code>LastFailedInvocationTime</code>.</li> <li>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 <code>config:PutEvaluations</code> permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the <code>config:PutEvaluations</code> permission.</li> <li>The rule's AWS Lambda function has returned <code>NOT_APPLICABLE</code> for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.</li> </ul>"
|
||||
"documentation":"<p>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.</p> <p>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.</p> <p>If AWS Config has no current evaluation results for the rule, it returns <code>INSUFFICIENT_DATA</code>. This result might indicate one of the following conditions:</p> <ul> <li> <p>AWS Config has never invoked an evaluation for the rule. To check whether it has, use the <code>DescribeConfigRuleEvaluationStatus</code> action to get the <code>LastSuccessfulInvocationTime</code> and <code>LastFailedInvocationTime</code>.</p> </li> <li> <p>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 <code>config:PutEvaluations</code> permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the <code>config:PutEvaluations</code> permission.</p> </li> <li> <p>The rule's AWS Lambda function has returned <code>NOT_APPLICABLE</code> for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.</p> </li> </ul>"
|
||||
},
|
||||
"DescribeComplianceByResource":{
|
||||
"name":"DescribeComplianceByResource",
|
||||
|
|
@ -104,7 +104,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidNextTokenException"}
|
||||
],
|
||||
"documentation":"<p>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. </p> <p>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.</p> <p>If AWS Config has no current evaluation results for the resource, it returns <code>INSUFFICIENT_DATA</code>. This result might indicate one of the following conditions about the rules that evaluate the resource:</p> <ul> <li>AWS Config has never invoked an evaluation for the rule. To check whether it has, use the <code>DescribeConfigRuleEvaluationStatus</code> action to get the <code>LastSuccessfulInvocationTime</code> and <code>LastFailedInvocationTime</code>.</li> <li>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 <code>config:PutEvaluations</code> permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the <code>config:PutEvaluations</code> permission.</li> <li>The rule's AWS Lambda function has returned <code>NOT_APPLICABLE</code> for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.</li> </ul>"
|
||||
"documentation":"<p>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.</p> <p>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.</p> <p>If AWS Config has no current evaluation results for the resource, it returns <code>INSUFFICIENT_DATA</code>. This result might indicate one of the following conditions about the rules that evaluate the resource:</p> <ul> <li> <p>AWS Config has never invoked an evaluation for the rule. To check whether it has, use the <code>DescribeConfigRuleEvaluationStatus</code> action to get the <code>LastSuccessfulInvocationTime</code> and <code>LastFailedInvocationTime</code>.</p> </li> <li> <p>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 <code>config:PutEvaluations</code> permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the <code>config:PutEvaluations</code> permission.</p> </li> <li> <p>The rule's AWS Lambda function has returned <code>NOT_APPLICABLE</code> for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.</p> </li> </ul>"
|
||||
},
|
||||
"DescribeConfigRuleEvaluationStatus":{
|
||||
"name":"DescribeConfigRuleEvaluationStatus",
|
||||
|
|
@ -143,7 +143,7 @@
|
|||
"errors":[
|
||||
{"shape":"NoSuchConfigurationRecorderException"}
|
||||
],
|
||||
"documentation":"<p>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.</p> <note> <p>Currently, you can specify only one configuration recorder per account.</p> </note>"
|
||||
"documentation":"<p>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.</p> <note> <p>Currently, you can specify only one configuration recorder per region in your account.</p> </note>"
|
||||
},
|
||||
"DescribeConfigurationRecorders":{
|
||||
"name":"DescribeConfigurationRecorders",
|
||||
|
|
@ -156,7 +156,7 @@
|
|||
"errors":[
|
||||
{"shape":"NoSuchConfigurationRecorderException"}
|
||||
],
|
||||
"documentation":"<p>Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account. </p> <note> <p>Currently, you can specify only one configuration recorder per account.</p> </note>"
|
||||
"documentation":"<p>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.</p> <note> <p>Currently, you can specify only one configuration recorder per region in your account.</p> </note>"
|
||||
},
|
||||
"DescribeDeliveryChannelStatus":{
|
||||
"name":"DescribeDeliveryChannelStatus",
|
||||
|
|
@ -169,7 +169,7 @@
|
|||
"errors":[
|
||||
{"shape":"NoSuchDeliveryChannelException"}
|
||||
],
|
||||
"documentation":"<p>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. </p> <note> <p>Currently, you can specify only one delivery channel per account.</p> </note>"
|
||||
"documentation":"<p>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.</p> <note> <p>Currently, you can specify only one delivery channel per region in your account.</p> </note>"
|
||||
},
|
||||
"DescribeDeliveryChannels":{
|
||||
"name":"DescribeDeliveryChannels",
|
||||
|
|
@ -182,7 +182,7 @@
|
|||
"errors":[
|
||||
{"shape":"NoSuchDeliveryChannelException"}
|
||||
],
|
||||
"documentation":"<p>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. </p> <note> <p>Currently, you can specify only one delivery channel per account.</p> </note>"
|
||||
"documentation":"<p>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.</p> <note> <p>Currently, you can specify only one delivery channel per region in your account.</p> </note>"
|
||||
},
|
||||
"GetComplianceDetailsByConfigRule":{
|
||||
"name":"GetComplianceDetailsByConfigRule",
|
||||
|
|
@ -282,7 +282,7 @@
|
|||
{"shape":"InsufficientPermissionsException"},
|
||||
{"shape":"NoAvailableConfigurationRecorderException"}
|
||||
],
|
||||
"documentation":"<p>Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations. </p> <p>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.</p> <p>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 <code>PutConfigRule</code> 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 <code>SourceIdentifier</code> key. This key is part of the <code>Source</code> object, which is part of the <code>ConfigRule</code> object. </p> <p>If you are adding a new AWS managed Config rule, specify the rule's identifier for the <code>SourceIdentifier</code> key. To reference AWS managed Config rule identifiers, see <a href=\"http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html\">Using AWS Managed Config Rules</a>.</p> <p>For any new rule that you add, specify the <code>ConfigRuleName</code> in the <code>ConfigRule</code> object. Do not specify the <code>ConfigRuleArn</code> or the <code>ConfigRuleId</code>. These values are generated by AWS Config for new rules.</p> <p>If you are updating a rule that you have added previously, specify the rule's <code>ConfigRuleName</code>, <code>ConfigRuleId</code>, or <code>ConfigRuleArn</code> in the <code>ConfigRule</code> data type that you use in this request.</p> <p>The maximum number of rules that AWS Config supports is 25.</p> <p>For more information about developing and using AWS Config rules, see <a href=\"http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html\">Evaluating AWS Resource Configurations with AWS Config</a> in the <i>AWS Config Developer Guide</i>.</p> <p/>"
|
||||
"documentation":"<p>Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.</p> <p>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.</p> <p>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 <code>PutConfigRule</code> 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 <code>SourceIdentifier</code> key. This key is part of the <code>Source</code> object, which is part of the <code>ConfigRule</code> object. </p> <p>If you are adding a new AWS managed Config rule, specify the rule's identifier for the <code>SourceIdentifier</code> key. To reference AWS managed Config rule identifiers, see <a href=\"http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html\">Using AWS Managed Config Rules</a>.</p> <p>For any new rule that you add, specify the <code>ConfigRuleName</code> in the <code>ConfigRule</code> object. Do not specify the <code>ConfigRuleArn</code> or the <code>ConfigRuleId</code>. These values are generated by AWS Config for new rules.</p> <p>If you are updating a rule that you added previously, you can specify the rule by <code>ConfigRuleName</code>, <code>ConfigRuleId</code>, or <code>ConfigRuleArn</code> in the <code>ConfigRule</code> data type that you use in this request.</p> <p>The maximum number of rules that AWS Config supports is 25.</p> <p>For more information about developing and using AWS Config rules, see <a href=\"http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html\">Evaluating AWS Resource Configurations with AWS Config</a> in the <i>AWS Config Developer Guide</i>.</p>"
|
||||
},
|
||||
"PutConfigurationRecorder":{
|
||||
"name":"PutConfigurationRecorder",
|
||||
|
|
@ -297,7 +297,7 @@
|
|||
{"shape":"InvalidRoleException"},
|
||||
{"shape":"InvalidRecordingGroupException"}
|
||||
],
|
||||
"documentation":"<p>Creates a new configuration recorder to record the selected resource configurations.</p> <p>You can use this action to change the role <code>roleARN</code> and/or the <code>recordingGroup</code> of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.</p> <note> <p>Currently, you can specify only one configuration recorder per account.</p> <p>If <code>ConfigurationRecorder</code> does not have the <b>recordingGroup</b> parameter specified, the default is to record all supported resource types.</p> </note>"
|
||||
"documentation":"<p>Creates a new configuration recorder to record the selected resource configurations.</p> <p>You can use this action to change the role <code>roleARN</code> and/or the <code>recordingGroup</code> of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.</p> <note> <p>Currently, you can specify only one configuration recorder per region in your account.</p> <p>If <code>ConfigurationRecorder</code> does not have the <b>recordingGroup</b> parameter specified, the default is to record all supported resource types.</p> </note>"
|
||||
},
|
||||
"PutDeliveryChannel":{
|
||||
"name":"PutDeliveryChannel",
|
||||
|
|
@ -315,7 +315,7 @@
|
|||
{"shape":"InvalidSNSTopicARNException"},
|
||||
{"shape":"InsufficientDeliveryPolicyException"}
|
||||
],
|
||||
"documentation":"<p>Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic.</p> <p>Before you can create a delivery channel, you must create a configuration recorder.</p> <p>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.</p> <note> <p>You can have only one delivery channel per AWS account.</p> </note>"
|
||||
"documentation":"<p>Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic.</p> <p>Before you can create a delivery channel, you must create a configuration recorder.</p> <p>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.</p> <note> <p>You can have only one delivery channel per region in your account.</p> </note>"
|
||||
},
|
||||
"PutEvaluations":{
|
||||
"name":"PutEvaluations",
|
||||
|
|
@ -346,7 +346,7 @@
|
|||
{"shape":"ResourceInUseException"},
|
||||
{"shape":"InvalidParameterValueException"}
|
||||
],
|
||||
"documentation":"<p>Evaluates your resources against the specified Config rules. You can specify up to 25 Config rules per request.</p> <p>An existing <a>StartConfigRulesEvaluation</a> 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 <code>ConfigRuleEvaluationStarted</code> notification when the evaluation starts.</p> <note> <p>You don't need to call the <code>StartConfigRulesEvaluation</code> API to run an evaluation for a new rule. When you create a new rule, AWS Config automatically evaluates your resources against the rule. </p> </note> <p>The <code>StartConfigRulesEvaluation</code> API is useful if you want to run on-demand evaluations, such as the following example:</p> <ol> <li><p>You have a custom rule that evaluates your IAM resources every 24 hours.</p></li> <li><p>You update your Lambda function to add additional conditions to your rule.</p></li> <li><p>Instead of waiting for the next periodic evaluation, you call the <code>StartConfigRulesEvaluation</code> API.</p></li> <li><p>AWS Config invokes your Lambda function and evaluates your IAM resources.</p></li> <li><p>Your custom rule will still run periodic evaluations every 24 hours.</p></li> </ol>"
|
||||
"documentation":"<p>Evaluates your resources against the specified Config rules. You can specify up to 25 Config rules per request.</p> <p>An existing <a>StartConfigRulesEvaluation</a> 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 <code>ConfigRuleEvaluationStarted</code> notification when the evaluation starts.</p> <note> <p>You don't need to call the <code>StartConfigRulesEvaluation</code> API to run an evaluation for a new rule. When you create a new rule, AWS Config automatically evaluates your resources against the rule. </p> </note> <p>The <code>StartConfigRulesEvaluation</code> API is useful if you want to run on-demand evaluations, such as the following example:</p> <ol> <li> <p>You have a custom rule that evaluates your IAM resources every 24 hours.</p> </li> <li> <p>You update your Lambda function to add additional conditions to your rule.</p> </li> <li> <p>Instead of waiting for the next periodic evaluation, you call the <code>StartConfigRulesEvaluation</code> API.</p> </li> <li> <p>AWS Config invokes your Lambda function and evaluates your IAM resources.</p> </li> <li> <p>Your custom rule will still run periodic evaluations every 24 hours.</p> </li> </ol>"
|
||||
},
|
||||
"StartConfigurationRecorder":{
|
||||
"name":"StartConfigurationRecorder",
|
||||
|
|
@ -419,7 +419,7 @@
|
|||
"documentation":"<p>Indicates whether the AWS Config rule is compliant.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>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. </p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"ComplianceByConfigRules":{
|
||||
"type":"list",
|
||||
|
|
@ -441,7 +441,7 @@
|
|||
"documentation":"<p>Indicates whether the AWS resource complies with all of the AWS Config rules that evaluated it.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>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. </p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"ComplianceByResources":{
|
||||
"type":"list",
|
||||
|
|
@ -459,7 +459,7 @@
|
|||
"documentation":"<p>Indicates whether the maximum count is reached.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The number of AWS resources or AWS Config rules responsible for the current compliance of the item, up to a maximum number. </p>"
|
||||
"documentation":"<p>The number of AWS resources or AWS Config rules responsible for the current compliance of the item, up to a maximum number.</p>"
|
||||
},
|
||||
"ComplianceResourceTypes":{
|
||||
"type":"list",
|
||||
|
|
@ -582,7 +582,7 @@
|
|||
},
|
||||
"MaximumExecutionFrequency":{
|
||||
"shape":"MaximumExecutionFrequency",
|
||||
"documentation":"<p>The maximum frequency with which AWS Config runs evaluations for a rule. You can specify a value for <code>MaximumExecutionFrequency</code> when: </p> <ul> <li> <p>You are using an AWS managed rule that is triggered at a periodic frequency.</p> </li> <li> <p>Your custom rule is triggered when AWS Config delivers the configuration snapshot.</p> </li> </ul> <p>For more information, see <a>ConfigSnapshotDeliveryProperties</a>.</p>"
|
||||
"documentation":"<p>The maximum frequency with which AWS Config runs evaluations for a rule. You can specify a value for <code>MaximumExecutionFrequency</code> when:</p> <ul> <li> <p>You are using an AWS managed rule that is triggered at a periodic frequency.</p> </li> <li> <p>Your custom rule is triggered when AWS Config delivers the configuration snapshot.</p> </li> </ul> <p>For more information, see <a>ConfigSnapshotDeliveryProperties</a>.</p>"
|
||||
},
|
||||
"ConfigRuleState":{
|
||||
"shape":"ConfigRuleState",
|
||||
|
|
@ -636,7 +636,7 @@
|
|||
},
|
||||
"FirstEvaluationStarted":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Indicates whether AWS Config has evaluated your resources against the rule at least once.</p> <ul> <li><code>true</code> - AWS Config has evaluated your AWS resources against the rule at least once.</li> <li><code>false</code> - AWS Config has not once finished evaluating your AWS resources against the rule.</li> </ul>"
|
||||
"documentation":"<p>Indicates whether AWS Config has evaluated your resources against the rule at least once.</p> <ul> <li> <p> <code>true</code> - AWS Config has evaluated your AWS resources against the rule at least once.</p> </li> <li> <p> <code>false</code> - AWS Config has not once finished evaluating your AWS resources against the rule.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>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.</p> <p>This action does not return status information about custom Config rules.</p>"
|
||||
|
|
@ -672,14 +672,14 @@
|
|||
"documentation":"<p>The frequency with which AWS Config delivers configuration snapshots.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Provides options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket in your delivery channel.</p> <note> <p>If you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot, see the following:</p> </note> <p>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:</p> <ul> <li> <p>The value for the <code>deliveryFrequency</code> 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.</p> </li> <li> <p>The value for the <code>MaximumExecutionFrequency</code> parameter, which sets the maximum frequency with which AWS Config invokes evaluations for the rule. For more information, see <a>ConfigRule</a>.</p> </li> </ul> <p>If the <code>deliveryFrequency</code> value is less frequent than the <code>MaximumExecutionFrequency</code> value for a rule, AWS Config invokes the rule only as often as the <code>deliveryFrequency</code> value.</p> <ol> <li> <p>For example, you want your rule to run evaluations when AWS Config delivers the configuration snapshot. </p> </li> <li> <p>You specify the <code>MaximumExecutionFrequency</code> value for <code>Six_Hours</code>. </p> </li> <li> <p>You then specify the delivery channel <code>deliveryFrequency</code> value for <code>TwentyFour_Hours</code>. </p> </li> <li> <p>Because the value for <code>deliveryFrequency</code> is less frequent than <code>MaximumExecutionFrequency</code>, AWS Config invokes evaluations for the rule every 24 hours. </p> </li> </ol> <p>You should set the <code>MaximumExecutionFrequency</code> value to be at least as frequent as the <code>deliveryFrequency</code> value. You can view the <code>deliveryFrequency</code> value by using the <code>DescribeDeliveryChannnels</code> action.</p> <p>To update the <code>deliveryFrequency</code> with which AWS Config delivers your configuration snapshots, use the <code>PutDeliveryChannel</code> action.</p>"
|
||||
"documentation":"<p>Provides options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket in your delivery channel.</p> <note> <p>If you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot, see the following:</p> </note> <p>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:</p> <ul> <li> <p>The value for the <code>deliveryFrequency</code> 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.</p> </li> <li> <p>The value for the <code>MaximumExecutionFrequency</code> parameter, which sets the maximum frequency with which AWS Config invokes evaluations for the rule. For more information, see <a>ConfigRule</a>.</p> </li> </ul> <p>If the <code>deliveryFrequency</code> value is less frequent than the <code>MaximumExecutionFrequency</code> value for a rule, AWS Config invokes the rule only as often as the <code>deliveryFrequency</code> value.</p> <ol> <li> <p>For example, you want your rule to run evaluations when AWS Config delivers the configuration snapshot.</p> </li> <li> <p>You specify the <code>MaximumExecutionFrequency</code> value for <code>Six_Hours</code>. </p> </li> <li> <p>You then specify the delivery channel <code>deliveryFrequency</code> value for <code>TwentyFour_Hours</code>.</p> </li> <li> <p>Because the value for <code>deliveryFrequency</code> is less frequent than <code>MaximumExecutionFrequency</code>, AWS Config invokes evaluations for the rule every 24 hours. </p> </li> </ol> <p>You should set the <code>MaximumExecutionFrequency</code> value to be at least as frequent as the <code>deliveryFrequency</code> value. You can view the <code>deliveryFrequency</code> value by using the <code>DescribeDeliveryChannnels</code> action.</p> <p>To update the <code>deliveryFrequency</code> with which AWS Config delivers your configuration snapshots, use the <code>PutDeliveryChannel</code> action.</p>"
|
||||
},
|
||||
"ConfigStreamDeliveryInfo":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"lastStatus":{
|
||||
"shape":"DeliveryStatus",
|
||||
"documentation":"<p>Status of the last attempted delivery.</p> <p><b>Note</b> Providing an SNS topic on a <a href=\"http://docs.aws.amazon.com/config/latest/APIReference/API_DeliveryChannel.html\">DeliveryChannel</a> for AWS Config is optional. If the SNS delivery is turned off, the last status will be <b>Not_Applicable</b>.</p>"
|
||||
"documentation":"<p>Status of the last attempted delivery.</p> <p> <b>Note</b> Providing an SNS topic on a <a href=\"http://docs.aws.amazon.com/config/latest/APIReference/API_DeliveryChannel.html\">DeliveryChannel</a> for AWS Config is optional. If the SNS delivery is turned off, the last status will be <b>Not_Applicable</b>.</p>"
|
||||
},
|
||||
"lastErrorCode":{
|
||||
"shape":"String",
|
||||
|
|
@ -694,7 +694,7 @@
|
|||
"documentation":"<p>The time from the last status change.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A list that contains the status of the delivery of the configuration stream notification to the Amazon SNS topic. </p>"
|
||||
"documentation":"<p>A list that contains the status of the delivery of the configuration stream notification to the Amazon SNS topic.</p>"
|
||||
},
|
||||
"Configuration":{"type":"string"},
|
||||
"ConfigurationItem":{
|
||||
|
|
@ -722,7 +722,7 @@
|
|||
},
|
||||
"configurationItemMD5Hash":{
|
||||
"shape":"ConfigurationItemMD5Hash",
|
||||
"documentation":"<p>Unique MD5 hash that represents the configuration item's state.</p> <p>You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.</p>"
|
||||
"documentation":"<p>Unique MD5 hash that represents the configuration item's state.</p> <p>You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.</p>"
|
||||
},
|
||||
"arn":{
|
||||
"shape":"ARN",
|
||||
|
|
@ -750,7 +750,7 @@
|
|||
},
|
||||
"resourceCreationTime":{
|
||||
"shape":"ResourceCreationTime",
|
||||
"documentation":"<p>The time stamp when the resource was created. </p>"
|
||||
"documentation":"<p>The time stamp when the resource was created.</p>"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"Tags",
|
||||
|
|
@ -795,7 +795,7 @@
|
|||
"members":{
|
||||
"name":{
|
||||
"shape":"RecorderName",
|
||||
"documentation":"<p>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.</p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"roleARN":{
|
||||
"shape":"String",
|
||||
|
|
@ -868,7 +868,8 @@
|
|||
"shape":"StringWithCharLimit64",
|
||||
"documentation":"<p>The name of the AWS Config rule that you want to delete.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DeleteConfigurationRecorderRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -890,7 +891,7 @@
|
|||
"documentation":"<p>The name of the delivery channel to delete.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> The input for the <a>DeleteDeliveryChannel</a> action. The action accepts the following data in JSON format. </p>"
|
||||
"documentation":"<p>The input for the <a>DeleteDeliveryChannel</a> action. The action accepts the following data in JSON format. </p>"
|
||||
},
|
||||
"DeleteEvaluationResultsRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -900,7 +901,8 @@
|
|||
"shape":"StringWithCharLimit64",
|
||||
"documentation":"<p>The name of the Config rule for which you want to delete the evaluation results.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DeleteEvaluationResultsResponse":{
|
||||
"type":"structure",
|
||||
|
|
@ -917,7 +919,7 @@
|
|||
"documentation":"<p>The name of the delivery channel through which the snapshot is delivered.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> The input for the <a>DeliverConfigSnapshot</a> action. </p>"
|
||||
"documentation":"<p>The input for the <a>DeliverConfigSnapshot</a> action.</p>"
|
||||
},
|
||||
"DeliverConfigSnapshotResponse":{
|
||||
"type":"structure",
|
||||
|
|
@ -927,14 +929,14 @@
|
|||
"documentation":"<p>The ID of the snapshot that is being created.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> The output for the <a>DeliverConfigSnapshot</a> action in JSON format. </p>"
|
||||
"documentation":"<p>The output for the <a>DeliverConfigSnapshot</a> action in JSON format.</p>"
|
||||
},
|
||||
"DeliveryChannel":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"name":{
|
||||
"shape":"ChannelName",
|
||||
"documentation":"<p>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.</p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"s3BucketName":{
|
||||
"shape":"String",
|
||||
|
|
@ -980,7 +982,7 @@
|
|||
"documentation":"<p>A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS topic.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The status of a specified delivery channel.</p> <p>Valid values: <code>Success</code> | <code>Failure</code></p>"
|
||||
"documentation":"<p>The status of a specified delivery channel.</p> <p>Valid values: <code>Success</code> | <code>Failure</code> </p>"
|
||||
},
|
||||
"DeliveryChannelStatusList":{
|
||||
"type":"list",
|
||||
|
|
@ -1009,7 +1011,8 @@
|
|||
"shape":"String",
|
||||
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DescribeComplianceByConfigRuleResponse":{
|
||||
"type":"structure",
|
||||
|
|
@ -1022,7 +1025,8 @@
|
|||
"shape":"String",
|
||||
"documentation":"<p>The string that you use in a subsequent request to get the next page of results in a paginated response.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DescribeComplianceByResourceRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1047,7 +1051,8 @@
|
|||
"shape":"NextToken",
|
||||
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DescribeComplianceByResourceResponse":{
|
||||
"type":"structure",
|
||||
|
|
@ -1060,16 +1065,18 @@
|
|||
"shape":"NextToken",
|
||||
"documentation":"<p>The string that you use in a subsequent request to get the next page of results in a paginated response.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DescribeConfigRuleEvaluationStatusRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ConfigRuleNames":{
|
||||
"shape":"ConfigRuleNames",
|
||||
"documentation":"<p>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. </p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DescribeConfigRuleEvaluationStatusResponse":{
|
||||
"type":"structure",
|
||||
|
|
@ -1078,7 +1085,8 @@
|
|||
"shape":"ConfigRuleEvaluationStatusList",
|
||||
"documentation":"<p>Status information about your AWS managed Config rules.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DescribeConfigRulesRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1091,7 +1099,8 @@
|
|||
"shape":"String",
|
||||
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DescribeConfigRulesResponse":{
|
||||
"type":"structure",
|
||||
|
|
@ -1104,14 +1113,15 @@
|
|||
"shape":"String",
|
||||
"documentation":"<p>The string that you use in a subsequent request to get the next page of results in a paginated response.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DescribeConfigurationRecorderStatusRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ConfigurationRecorderNames":{
|
||||
"shape":"ConfigurationRecorderNameList",
|
||||
"documentation":"<p>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. </p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The input for the <a>DescribeConfigurationRecorderStatus</a> action.</p>"
|
||||
|
|
@ -1121,7 +1131,7 @@
|
|||
"members":{
|
||||
"ConfigurationRecordersStatus":{
|
||||
"shape":"ConfigurationRecorderStatusList",
|
||||
"documentation":"<p> A list that contains status of the specified recorders. </p>"
|
||||
"documentation":"<p>A list that contains status of the specified recorders.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The output for the <a>DescribeConfigurationRecorderStatus</a> action in JSON format.</p>"
|
||||
|
|
@ -1252,7 +1262,7 @@
|
|||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The details of an AWS Config evaluation. Provides the AWS resource that was evaluated, the compliance of the resource, related timestamps, and supplementary information. </p>"
|
||||
"documentation":"<p>The details of an AWS Config evaluation. Provides the AWS resource that was evaluated, the compliance of the resource, related timestamps, and supplementary information.</p>"
|
||||
},
|
||||
"EvaluationResultIdentifier":{
|
||||
"type":"structure",
|
||||
|
|
@ -1320,7 +1330,8 @@
|
|||
"shape":"NextToken",
|
||||
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"GetComplianceDetailsByConfigRuleResponse":{
|
||||
"type":"structure",
|
||||
|
|
@ -1333,7 +1344,8 @@
|
|||
"shape":"NextToken",
|
||||
"documentation":"<p>The string that you use in a subsequent request to get the next page of results in a paginated response.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"GetComplianceDetailsByResourceRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1358,7 +1370,8 @@
|
|||
"shape":"String",
|
||||
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"GetComplianceDetailsByResourceResponse":{
|
||||
"type":"structure",
|
||||
|
|
@ -1371,7 +1384,8 @@
|
|||
"shape":"String",
|
||||
"documentation":"<p>The string that you use in a subsequent request to get the next page of results in a paginated response.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"GetComplianceSummaryByConfigRuleResponse":{
|
||||
"type":"structure",
|
||||
|
|
@ -1380,7 +1394,8 @@
|
|||
"shape":"ComplianceSummary",
|
||||
"documentation":"<p>The number of AWS Config rules that are compliant and the number that are noncompliant, up to a maximum of 25 for each.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"GetComplianceSummaryByResourceTypeRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1389,7 +1404,8 @@
|
|||
"shape":"ResourceTypes",
|
||||
"documentation":"<p>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.</p> <p>For this request, you can specify an AWS resource type such as <code>AWS::EC2::Instance</code>, and you can specify that the resource type is an AWS account by specifying <code>AWS::::Account</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"GetComplianceSummaryByResourceTypeResponse":{
|
||||
"type":"structure",
|
||||
|
|
@ -1398,7 +1414,8 @@
|
|||
"shape":"ComplianceSummariesByResourceType",
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"GetResourceConfigHistoryRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1464,7 +1481,7 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>Indicates one of the following errors:</p> <ul> <li>The rule cannot be created because the IAM role assigned to AWS Config lacks permissions to perform the config:Put* action.</li> <li>The AWS Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.</li> </ul>",
|
||||
"documentation":"<p>Indicates one of the following errors:</p> <ul> <li> <p>The rule cannot be created because the IAM role assigned to AWS Config lacks permissions to perform the config:Put* action.</p> </li> <li> <p>The AWS Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.</p> </li> </ul>",
|
||||
"exception":true
|
||||
},
|
||||
"Integer":{"type":"integer"},
|
||||
|
|
@ -1593,7 +1610,8 @@
|
|||
"shape":"NextToken",
|
||||
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"ListDiscoveredResourcesResponse":{
|
||||
"type":"structure",
|
||||
|
|
@ -1606,7 +1624,8 @@
|
|||
"shape":"NextToken",
|
||||
"documentation":"<p>The string that you use in a subsequent request to get the next page of results in a paginated response.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"MaxNumberOfConfigRulesExceededException":{
|
||||
"type":"structure",
|
||||
|
|
@ -1711,7 +1730,8 @@
|
|||
"required":["ConfigRule"],
|
||||
"members":{
|
||||
"ConfigRule":{"shape":"ConfigRule"}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"PutConfigurationRecorderRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1747,7 +1767,8 @@
|
|||
"shape":"String",
|
||||
"documentation":"<p>An encrypted token that associates an evaluation with an AWS Config rule. Identifies the rule and the event that triggered the evaluation</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"PutEvaluationsResponse":{
|
||||
"type":"structure",
|
||||
|
|
@ -1756,7 +1777,8 @@
|
|||
"shape":"Evaluations",
|
||||
"documentation":"<p>Requests that failed because of a client or server error.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"RecorderName":{
|
||||
"type":"string",
|
||||
|
|
@ -1903,7 +1925,8 @@
|
|||
"AWS::RDS::DBSecurityGroup",
|
||||
"AWS::RDS::DBSnapshot",
|
||||
"AWS::RDS::EventSubscription",
|
||||
"AWS::ElasticLoadBalancingV2::LoadBalancer"
|
||||
"AWS::ElasticLoadBalancingV2::LoadBalancer",
|
||||
"AWS::S3::Bucket"
|
||||
]
|
||||
},
|
||||
"ResourceTypeList":{
|
||||
|
|
@ -1936,7 +1959,7 @@
|
|||
"documentation":"<p>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 <code>ComplianceResourceTypes</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Defines which resources trigger an evaluation for an AWS Config rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration. </p>"
|
||||
"documentation":"<p>Defines which resources trigger an evaluation for an AWS Config rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.</p>"
|
||||
},
|
||||
"Source":{
|
||||
"type":"structure",
|
||||
|
|
@ -1947,7 +1970,7 @@
|
|||
},
|
||||
"SourceIdentifier":{
|
||||
"shape":"StringWithCharLimit256",
|
||||
"documentation":"<p>For AWS managed Config rules, a pre-defined identifier from a list. To reference the list, see <a href=\"http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html\">Using AWS Managed Config Rules</a>.</p> <p>For custom Config rules, the identifier is the Amazon Resource Name (ARN) of the rule's AWS Lambda function.</p>"
|
||||
"documentation":"<p>For AWS Config managed rules, a predefined identifier from a list. For example, <code>IAM_PASSWORD_POLICY</code> is a managed rule. To reference a managed rule, see <a href=\"http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html\">Using AWS Managed Config Rules</a>.</p> <p>For custom rules, the identifier is the Amazon Resource Name (ARN) of the rule's AWS Lambda function, such as <code>arn:aws:lambda:us-east-1:123456789012:function:custom_rule_name</code>.</p>"
|
||||
},
|
||||
"SourceDetails":{
|
||||
"shape":"SourceDetails",
|
||||
|
|
@ -1961,11 +1984,11 @@
|
|||
"members":{
|
||||
"EventSource":{
|
||||
"shape":"EventSource",
|
||||
"documentation":"<p> </p> <p>The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.</p>"
|
||||
"documentation":"<p>The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.</p>"
|
||||
},
|
||||
"MessageType":{
|
||||
"shape":"MessageType",
|
||||
"documentation":"<p>The type of notification that triggers AWS Config to run an evaluation. You can specify the following notification types:</p> <p><code>ConfigurationItemChangeNotification</code> - Triggers an evaluation when AWS Config delivers a configuration item change notification.</p> <p><code>ScheduledNotification</code> - Triggers a periodic evaluation at the frequency specified for <code>MaximumExecutionFrequency</code>.</p> <p><code>ConfigurationSnapshotDeliveryCompleted</code> - Triggers a periodic evaluation when AWS Config delivers a configuration snapshot.</p>"
|
||||
"documentation":"<p>The type of notification that triggers AWS Config to run an evaluation. You can specify the following notification types:</p> <p> <code>ConfigurationItemChangeNotification</code> - Triggers an evaluation when AWS Config delivers a configuration item change notification.</p> <p> <code>ScheduledNotification</code> - Triggers a periodic evaluation at the frequency specified for <code>MaximumExecutionFrequency</code>.</p> <p> <code>ConfigurationSnapshotDeliveryCompleted</code> - Triggers a periodic evaluation when AWS Config delivers a configuration snapshot.</p>"
|
||||
},
|
||||
"MaximumExecutionFrequency":{
|
||||
"shape":"MaximumExecutionFrequency",
|
||||
|
|
@ -1987,7 +2010,8 @@
|
|||
"shape":"ReevaluateConfigRuleNames",
|
||||
"documentation":"<p>The list of names of Config rules that you want to run evaluations for.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"StartConfigRulesEvaluationResponse":{
|
||||
"type":"structure",
|
||||
|
|
|
|||
|
|
@ -124,6 +124,22 @@
|
|||
],
|
||||
"documentation":"<p>Deletes the repository policy from a specified repository.</p>"
|
||||
},
|
||||
"DescribeImages":{
|
||||
"name":"DescribeImages",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeImagesRequest"},
|
||||
"output":{"shape":"DescribeImagesResponse"},
|
||||
"errors":[
|
||||
{"shape":"ServerException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"RepositoryNotFoundException"},
|
||||
{"shape":"ImageNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Returns metadata about the images in a repository, including image size and creation date.</p> <note> <p>Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the <code>docker images</code> command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by <a>DescribeImages</a>.</p> </note>"
|
||||
},
|
||||
"DescribeRepositories":{
|
||||
"name":"DescribeRepositories",
|
||||
"http":{
|
||||
|
|
@ -470,9 +486,13 @@
|
|||
"CreateRepositoryResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"repository":{"shape":"Repository"}
|
||||
"repository":{
|
||||
"shape":"Repository",
|
||||
"documentation":"<p>The repository that was created.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreationTimestamp":{"type":"timestamp"},
|
||||
"DeleteRepositoryPolicyRequest":{
|
||||
"type":"structure",
|
||||
"required":["repositoryName"],
|
||||
|
|
@ -525,7 +545,63 @@
|
|||
"DeleteRepositoryResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"repository":{"shape":"Repository"}
|
||||
"repository":{
|
||||
"shape":"Repository",
|
||||
"documentation":"<p>The repository that was deleted.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeImagesFilter":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"tagStatus":{
|
||||
"shape":"TagStatus",
|
||||
"documentation":"<p>The tag status with which to filter your <a>DescribeImages</a> results. You can filter results based on whether they are <code>TAGGED</code> or <code>UNTAGGED</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An object representing a filter on a <a>DescribeImages</a> operation.</p>"
|
||||
},
|
||||
"DescribeImagesRequest":{
|
||||
"type":"structure",
|
||||
"required":["repositoryName"],
|
||||
"members":{
|
||||
"registryId":{
|
||||
"shape":"RegistryId",
|
||||
"documentation":"<p>The AWS account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed.</p>"
|
||||
},
|
||||
"repositoryName":{
|
||||
"shape":"RepositoryName",
|
||||
"documentation":"<p>A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.</p>"
|
||||
},
|
||||
"imageIds":{
|
||||
"shape":"ImageIdentifierList",
|
||||
"documentation":"<p>The list of image IDs for the requested repository.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeImages</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p>"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum number of repository results returned by <code>DescribeImages</code> in paginated output. When this parameter is used, <code>DescribeImages</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeImages</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>DescribeImages</code> returns up to 100 results and a <code>nextToken</code> value, if applicable.</p>"
|
||||
},
|
||||
"filter":{
|
||||
"shape":"DescribeImagesFilter",
|
||||
"documentation":"<p>The filter key and value with which to filter your <code>DescribeImages</code> results.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeImagesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"imageDetails":{
|
||||
"shape":"ImageDetailList",
|
||||
"documentation":"<p>A list of <a>ImageDetail</a> objects that contain data about the image.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>DescribeImages</code> request. When the results of a <code>DescribeImages</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeRepositoriesRequest":{
|
||||
|
|
@ -698,6 +774,40 @@
|
|||
"documentation":"<p>The specified image has already been pushed, and there are no changes to the manifest or image tag since the last push.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ImageDetail":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"registryId":{
|
||||
"shape":"RegistryId",
|
||||
"documentation":"<p>The AWS account ID associated with the registry to which this image belongs.</p>"
|
||||
},
|
||||
"repositoryName":{
|
||||
"shape":"RepositoryName",
|
||||
"documentation":"<p>The name of the repository to which this image belongs.</p>"
|
||||
},
|
||||
"imageDigest":{
|
||||
"shape":"ImageDigest",
|
||||
"documentation":"<p>The <code>sha256</code> digest of the image manifest.</p>"
|
||||
},
|
||||
"imageTags":{
|
||||
"shape":"ImageTagList",
|
||||
"documentation":"<p>The list of tags associated with this image.</p>"
|
||||
},
|
||||
"imageSizeInBytes":{
|
||||
"shape":"ImageSizeInBytes",
|
||||
"documentation":"<p>The size, in bytes, of the image in the repository.</p> <note> <p>Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the <code>docker images</code> command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by <a>DescribeImages</a>.</p> </note>"
|
||||
},
|
||||
"imagePushedAt":{
|
||||
"shape":"PushTimestamp",
|
||||
"documentation":"<p>The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An object that describes an image returned by a <a>DescribeImages</a> operation.</p>"
|
||||
},
|
||||
"ImageDetailList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ImageDetail"}
|
||||
},
|
||||
"ImageDigest":{"type":"string"},
|
||||
"ImageFailure":{
|
||||
"type":"structure",
|
||||
|
|
@ -757,7 +867,20 @@
|
|||
"member":{"shape":"Image"}
|
||||
},
|
||||
"ImageManifest":{"type":"string"},
|
||||
"ImageNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"documentation":"<p>The image requested does not exist in the specified repository.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ImageSizeInBytes":{"type":"long"},
|
||||
"ImageTag":{"type":"string"},
|
||||
"ImageTagList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ImageTag"}
|
||||
},
|
||||
"InitiateLayerUploadRequest":{
|
||||
"type":"structure",
|
||||
"required":["repositoryName"],
|
||||
|
|
@ -1020,6 +1143,7 @@
|
|||
"min":0
|
||||
},
|
||||
"ProxyEndpoint":{"type":"string"},
|
||||
"PushTimestamp":{"type":"timestamp"},
|
||||
"PutImageRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -1072,6 +1196,10 @@
|
|||
"repositoryUri":{
|
||||
"shape":"Url",
|
||||
"documentation":"<p>The URI for the repository. You can use this URI for Docker <code>push</code> and <code>pull</code> operations.</p>"
|
||||
},
|
||||
"createdAt":{
|
||||
"shape":"CreationTimestamp",
|
||||
"documentation":"<p>The date and time, in JavaScript date/time format, when the repository was created.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An object representing a repository.</p>"
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@
|
|||
{"shape":"TagQuotaPerResourceExceeded"},
|
||||
{"shape":"InvalidARNFault"}
|
||||
],
|
||||
"documentation":"<p>The <i>AddTagsToResource</i> action adds up to 10 cost allocation tags to the named resource. A <i>cost allocation tag</i> is a key-value pair where the key and value are case-sensitive. Cost allocation tags can be used to categorize and track your AWS costs.</p> <p> 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 <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Tagging.html\">Using Cost Allocation Tags in Amazon ElastiCache</a> in the <i>ElastiCache User Guide</i>.</p>"
|
||||
"documentation":"<p>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.</p> <p> 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 <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Tagging.html\">Using Cost Allocation Tags in Amazon ElastiCache</a> in the <i>ElastiCache User Guide</i>.</p>"
|
||||
},
|
||||
"AuthorizeCacheSecurityGroupIngress":{
|
||||
"name":"AuthorizeCacheSecurityGroupIngress",
|
||||
|
|
@ -46,7 +46,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>AuthorizeCacheSecurityGroupIngress</i> action 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.</p> <note> <p>You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.</p> </note>"
|
||||
"documentation":"<p>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.</p> <note> <p>You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.</p> </note>"
|
||||
},
|
||||
"CopySnapshot":{
|
||||
"name":"CopySnapshot",
|
||||
|
|
@ -67,7 +67,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>CopySnapshot</i> action makes a copy of an existing snapshot.</p> <important> <p>Users or groups that have permissions to use the <i>CopySnapshot</i> API 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 <i>CopySnapshot</i> API. For more information about using IAM to control the use of ElastiCache APIs, see <a href=\"http://docs.aws.amazon.com/ElastiCache/latest/Snapshots.Exporting.html\">Exporting Snapshots</a> and <a href=\"http://docs.aws.amazon.com/ElastiCache/latest/IAM.html\">Authentication & Access Control</a>.</p> </important> <p class=\"title\"> <b>Erorr Message:</b> </p> <ul> <li> <p> <b>Error Message:</b> The authenticated user does not have sufficient permissions to perform the desired activity.</p> <p> <b>Solution:</b> Contact your system administrator to get the needed permissions.</p> </li> </ul>"
|
||||
"documentation":"<p>Makes a copy of an existing snapshot.</p> <note> <p>This operation is valid for Redis only.</p> </note> <important> <p>Users or groups that have permissions to use the <code>CopySnapshot</code> 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 <code>CopySnapshot</code> operation. For more information about using IAM to control the use of ElastiCache operations, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Snapshots.Exporting.html\">Exporting Snapshots</a> and <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/IAM.html\">Authentication & Access Control</a>.</p> </important> <p>You could receive the following error messages.</p> <p class=\"title\"> <b>Error Messages</b> </p> <ul> <li> <p> <b>Error Message:</b> The S3 bucket %s is outside of the region.</p> <p> <b>Solution:</b> Create an Amazon S3 bucket in the same region as your snapshot. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Snapshots.Exporting.html#Snapshots.Exporting.CreateBucket\">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User Guide.</p> </li> <li> <p> <b>Error Message:</b> The S3 bucket %s does not exist.</p> <p> <b>Solution:</b> Create an Amazon S3 bucket in the same region as your snapshot. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Snapshots.Exporting.html#Snapshots.Exporting.CreateBucket\">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User Guide.</p> </li> <li> <p> <b>Error Message:</b> The S3 bucket %s is not owned by the authenticated user.</p> <p> <b>Solution:</b> Create an Amazon S3 bucket in the same region as your snapshot. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Snapshots.Exporting.html#Snapshots.Exporting.CreateBucket\">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User Guide.</p> </li> <li> <p> <b>Error Message:</b> The authenticated user does not have sufficient permissions to perform the desired activity.</p> <p> <b>Solution:</b> Contact your system administrator to get the needed permissions.</p> </li> <li> <p> <b>Error Message:</b> The S3 bucket %s already contains an object with key %s.</p> <p> <b>Solution:</b> Give the <code>TargetSnapshotName</code> a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for <code>TargetSnapshotName</code>.</p> </li> <li> <p> <b>Error Message: </b> ElastiCache has not been granted READ permissions %s on the S3 Bucket.</p> <p> <b>Solution:</b> Add List and Read permissions on the bucket. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Snapshots.Exporting.html#Snapshots.Exporting.GrantAccess\">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the ElastiCache User Guide.</p> </li> <li> <p> <b>Error Message: </b> ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.</p> <p> <b>Solution:</b> Add Upload/Delete permissions on the bucket. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Snapshots.Exporting.html#Snapshots.Exporting.GrantAccess\">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the ElastiCache User Guide.</p> </li> <li> <p> <b>Error Message: </b> ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.</p> <p> <b>Solution:</b> Add View Permissions on the bucket. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Snapshots.Exporting.html#Snapshots.Exporting.GrantAccess\">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the ElastiCache User Guide.</p> </li> </ul>"
|
||||
},
|
||||
"CreateCacheCluster":{
|
||||
"name":"CreateCacheCluster",
|
||||
|
|
@ -96,7 +96,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>CreateCacheCluster</i> action creates a cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software, either Memcached or Redis.</p>"
|
||||
"documentation":"<p>Creates a cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software, either Memcached or Redis.</p> <important> <p>Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.</p> </important>"
|
||||
},
|
||||
"CreateCacheParameterGroup":{
|
||||
"name":"CreateCacheParameterGroup",
|
||||
|
|
@ -116,7 +116,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>CreateCacheParameterGroup</i> action 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.</p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"CreateCacheSecurityGroup":{
|
||||
"name":"CreateCacheSecurityGroup",
|
||||
|
|
@ -135,7 +135,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>CreateCacheSecurityGroup</i> action creates a new cache security group. Use a cache security group to control access to one or more cache clusters.</p> <p>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 <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html\">CreateCacheSubnetGroup</a>.</p>"
|
||||
"documentation":"<p>Creates a new cache security group. Use a cache security group to control access to one or more cache clusters.</p> <p>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 <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html\">CreateCacheSubnetGroup</a>.</p>"
|
||||
},
|
||||
"CreateCacheSubnetGroup":{
|
||||
"name":"CreateCacheSubnetGroup",
|
||||
|
|
@ -154,7 +154,7 @@
|
|||
{"shape":"CacheSubnetQuotaExceededFault"},
|
||||
{"shape":"InvalidSubnet"}
|
||||
],
|
||||
"documentation":"<p>The <i>CreateCacheSubnetGroup</i> action creates a new cache subnet group.</p> <p>Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).</p>"
|
||||
"documentation":"<p>Creates a new cache subnet group.</p> <p>Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).</p>"
|
||||
},
|
||||
"CreateReplicationGroup":{
|
||||
"name":"CreateReplicationGroup",
|
||||
|
|
@ -180,10 +180,11 @@
|
|||
{"shape":"CacheParameterGroupNotFoundFault"},
|
||||
{"shape":"InvalidVPCNetworkStateFault"},
|
||||
{"shape":"TagQuotaPerResourceExceeded"},
|
||||
{"shape":"NodeGroupsPerReplicationGroupQuotaExceededFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>CreateReplicationGroup</i> action 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.</p> <p>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.</p> <note> <p>This action is valid only for Redis.</p> </note>"
|
||||
"documentation":"<p>Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.</p> <p>A Redis (cluster mode disabled) replication group is a collection of 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.</p> <p>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).</p> <p>When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group once it has been created.</p> <note> <p>This operation is valid for Redis only.</p> </note>"
|
||||
},
|
||||
"CreateSnapshot":{
|
||||
"name":"CreateSnapshot",
|
||||
|
|
@ -199,13 +200,15 @@
|
|||
"errors":[
|
||||
{"shape":"SnapshotAlreadyExistsFault"},
|
||||
{"shape":"CacheClusterNotFoundFault"},
|
||||
{"shape":"ReplicationGroupNotFoundFault"},
|
||||
{"shape":"InvalidCacheClusterStateFault"},
|
||||
{"shape":"InvalidReplicationGroupStateFault"},
|
||||
{"shape":"SnapshotQuotaExceededFault"},
|
||||
{"shape":"SnapshotFeatureNotSupportedFault"},
|
||||
{"shape":"InvalidParameterCombinationException"},
|
||||
{"shape":"InvalidParameterValueException"}
|
||||
],
|
||||
"documentation":"<p>The <i>CreateSnapshot</i> action creates a copy of an entire cache cluster at a specific moment in time.</p>"
|
||||
"documentation":"<p>Creates a copy of an entire cache cluster or replication group at a specific moment in time.</p> <note> <p>This operation is valid for Redis only.</p> </note>"
|
||||
},
|
||||
"DeleteCacheCluster":{
|
||||
"name":"DeleteCacheCluster",
|
||||
|
|
@ -227,7 +230,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>DeleteCacheCluster</i> action deletes a previously provisioned cache cluster. <i>DeleteCacheCluster</i> deletes all associated cache nodes, node endpoints and the cache cluster itself. When you receive a successful response from this action, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this action.</p> <p>This API cannot be used to delete a cache cluster that is the last read replica of a replication group that has Multi-AZ mode enabled.</p>"
|
||||
"documentation":"<p>Deletes a previously provisioned cache cluster. <code>DeleteCacheCluster</code> 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.</p> <p>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.</p> <important> <p>Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.</p> </important>"
|
||||
},
|
||||
"DeleteCacheParameterGroup":{
|
||||
"name":"DeleteCacheParameterGroup",
|
||||
|
|
@ -242,7 +245,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>DeleteCacheParameterGroup</i> action deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.</p>"
|
||||
"documentation":"<p>Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.</p>"
|
||||
},
|
||||
"DeleteCacheSecurityGroup":{
|
||||
"name":"DeleteCacheSecurityGroup",
|
||||
|
|
@ -257,7 +260,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>DeleteCacheSecurityGroup</i> action deletes a cache security group.</p> <note> <p>You cannot delete a cache security group if it is associated with any cache clusters.</p> </note>"
|
||||
"documentation":"<p>Deletes a cache security group.</p> <note> <p>You cannot delete a cache security group if it is associated with any cache clusters.</p> </note>"
|
||||
},
|
||||
"DeleteCacheSubnetGroup":{
|
||||
"name":"DeleteCacheSubnetGroup",
|
||||
|
|
@ -270,7 +273,7 @@
|
|||
{"shape":"CacheSubnetGroupInUse"},
|
||||
{"shape":"CacheSubnetGroupNotFoundFault"}
|
||||
],
|
||||
"documentation":"<p>The <i>DeleteCacheSubnetGroup</i> action deletes a cache subnet group.</p> <note> <p>You cannot delete a cache subnet group if it is associated with any cache clusters.</p> </note>"
|
||||
"documentation":"<p>Deletes a cache subnet group.</p> <note> <p>You cannot delete a cache subnet group if it is associated with any cache clusters.</p> </note>"
|
||||
},
|
||||
"DeleteReplicationGroup":{
|
||||
"name":"DeleteReplicationGroup",
|
||||
|
|
@ -292,7 +295,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>DeleteReplicationGroup</i> action deletes an existing replication group. By default, this action deletes the entire replication group, including the primary cluster and all of the read replicas. You can optionally delete only the read replicas, while retaining the primary cluster.</p> <p>When you receive a successful response from this action, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this action.</p>"
|
||||
"documentation":"<p>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 <code>RetainPrimaryCluster=true</code>.</p> <p>When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.</p> <note> <p>This operation is valid for Redis only.</p> </note>"
|
||||
},
|
||||
"DeleteSnapshot":{
|
||||
"name":"DeleteSnapshot",
|
||||
|
|
@ -311,7 +314,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>DeleteSnapshot</i> action deletes an existing snapshot. When you receive a successful response from this action, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this action.</p>"
|
||||
"documentation":"<p>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.</p> <note> <p>This operation is valid for Redis only.</p> </note>"
|
||||
},
|
||||
"DescribeCacheClusters":{
|
||||
"name":"DescribeCacheClusters",
|
||||
|
|
@ -329,7 +332,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>DescribeCacheClusters</i> action 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.</p> <p>By default, abbreviated information about the cache clusters(s) will be returned. You can use the optional <i>ShowDetails</i> 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.</p> <p>If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.</p> <p>If the cluster is in the DELETING state, only cluster level information will be displayed.</p> <p>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 <i>available</i>, the cluster is ready for use.</p> <p>If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.</p>"
|
||||
"documentation":"<p>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.</p> <p>By default, abbreviated information about the cache clusters are returned. You can use the optional <code>ShowDetails</code> 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.</p> <p>If the cluster is in the CREATING state, only cluster-level information is displayed until all of the nodes are successfully provisioned.</p> <p>If the cluster is in the DELETING state, only cluster-level information is displayed.</p> <p>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 <code>available</code>, the cluster is ready for use.</p> <p>If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.</p>"
|
||||
},
|
||||
"DescribeCacheEngineVersions":{
|
||||
"name":"DescribeCacheEngineVersions",
|
||||
|
|
@ -342,7 +345,7 @@
|
|||
"shape":"CacheEngineVersionMessage",
|
||||
"resultWrapper":"DescribeCacheEngineVersionsResult"
|
||||
},
|
||||
"documentation":"<p>The <i>DescribeCacheEngineVersions</i> action returns a list of the available cache engines and their versions.</p>"
|
||||
"documentation":"<p>Returns a list of the available cache engines and their versions.</p>"
|
||||
},
|
||||
"DescribeCacheParameterGroups":{
|
||||
"name":"DescribeCacheParameterGroups",
|
||||
|
|
@ -360,7 +363,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>DescribeCacheParameterGroups</i> action 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.</p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"DescribeCacheParameters":{
|
||||
"name":"DescribeCacheParameters",
|
||||
|
|
@ -378,7 +381,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>DescribeCacheParameters</i> action returns the detailed parameter list for a particular cache parameter group.</p>"
|
||||
"documentation":"<p>Returns the detailed parameter list for a particular cache parameter group.</p>"
|
||||
},
|
||||
"DescribeCacheSecurityGroups":{
|
||||
"name":"DescribeCacheSecurityGroups",
|
||||
|
|
@ -396,7 +399,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>DescribeCacheSecurityGroups</i> action 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.</p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"DescribeCacheSubnetGroups":{
|
||||
"name":"DescribeCacheSubnetGroups",
|
||||
|
|
@ -412,7 +415,7 @@
|
|||
"errors":[
|
||||
{"shape":"CacheSubnetGroupNotFoundFault"}
|
||||
],
|
||||
"documentation":"<p>The <i>DescribeCacheSubnetGroups</i> action 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.</p>"
|
||||
"documentation":"<p>Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.</p>"
|
||||
},
|
||||
"DescribeEngineDefaultParameters":{
|
||||
"name":"DescribeEngineDefaultParameters",
|
||||
|
|
@ -429,7 +432,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>DescribeEngineDefaultParameters</i> action returns the default engine and system parameter information for the specified cache engine.</p>"
|
||||
"documentation":"<p>Returns the default engine and system parameter information for the specified cache engine.</p>"
|
||||
},
|
||||
"DescribeEvents":{
|
||||
"name":"DescribeEvents",
|
||||
|
|
@ -446,7 +449,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>DescribeEvents</i> action 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.</p> <p>By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.</p>"
|
||||
"documentation":"<p>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.</p> <p>By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.</p>"
|
||||
},
|
||||
"DescribeReplicationGroups":{
|
||||
"name":"DescribeReplicationGroups",
|
||||
|
|
@ -464,7 +467,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>DescribeReplicationGroups</i> action returns information about a particular replication group. If no identifier is specified, <i>DescribeReplicationGroups</i> returns information about all replication groups.</p>"
|
||||
"documentation":"<p>Returns information about a particular replication group. If no identifier is specified, <code>DescribeReplicationGroups</code> returns information about all replication groups.</p> <note> <p>This operation is valid for Redis only.</p> </note>"
|
||||
},
|
||||
"DescribeReservedCacheNodes":{
|
||||
"name":"DescribeReservedCacheNodes",
|
||||
|
|
@ -482,7 +485,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>DescribeReservedCacheNodes</i> action returns information about reserved cache nodes for this account, or about a specified reserved cache node.</p>"
|
||||
"documentation":"<p>Returns information about reserved cache nodes for this account, or about a specified reserved cache node.</p>"
|
||||
},
|
||||
"DescribeReservedCacheNodesOfferings":{
|
||||
"name":"DescribeReservedCacheNodesOfferings",
|
||||
|
|
@ -500,7 +503,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>DescribeReservedCacheNodesOfferings</i> action lists available reserved cache node offerings.</p>"
|
||||
"documentation":"<p>Lists available reserved cache node offerings.</p>"
|
||||
},
|
||||
"DescribeSnapshots":{
|
||||
"name":"DescribeSnapshots",
|
||||
|
|
@ -519,7 +522,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>DescribeSnapshots</i> action returns information about cache cluster snapshots. By default, <i>DescribeSnapshots</i> lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.</p>"
|
||||
"documentation":"<p>Returns information about cache cluster or replication group snapshots. By default, <code>DescribeSnapshots</code> lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.</p> <note> <p>This operation is valid for Redis only.</p> </note>"
|
||||
},
|
||||
"ListAllowedNodeTypeModifications":{
|
||||
"name":"ListAllowedNodeTypeModifications",
|
||||
|
|
@ -538,7 +541,7 @@
|
|||
{"shape":"InvalidParameterCombinationException"},
|
||||
{"shape":"InvalidParameterValueException"}
|
||||
],
|
||||
"documentation":"<p>The <code>ListAllowedNodeTypeModifications</code> action lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.</p> <p>When you use the <code>ModifyCacheCluster</code> or <code>ModifyReplicationGroup</code> APIs to scale up your cluster or replication group, the value of the <i>CacheNodeType</i> parameter must be one of the node types returned by this action.</p>"
|
||||
"documentation":"<p>Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.</p> <p>When you use the <code>ModifyCacheCluster</code> or <code>ModifyReplicationGroup</code> operations to scale up your cluster or replication group, the value of the <code>CacheNodeType</code> parameter must be one of the node types returned by this operation.</p>"
|
||||
},
|
||||
"ListTagsForResource":{
|
||||
"name":"ListTagsForResource",
|
||||
|
|
@ -556,7 +559,7 @@
|
|||
{"shape":"SnapshotNotFoundFault"},
|
||||
{"shape":"InvalidARNFault"}
|
||||
],
|
||||
"documentation":"<p>The <i>ListTagsForResource</i> action lists all cost allocation tags currently on the named resource. A <i>cost allocation tag</i> is a key-value pair where the key is case-sensitive and the value is optional. Cost allocation tags can be used to categorize and track your AWS costs.</p> <p>You can have a maximum of 10 cost allocation tags on an ElastiCache resource. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/BestPractices.html\">Using Cost Allocation Tags in Amazon ElastiCache</a>.</p>"
|
||||
"documentation":"<p>Lists all cost allocation tags currently on the named resource. A <code>cost allocation tag</code> 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.</p> <p>You can have a maximum of 10 cost allocation tags on an ElastiCache resource. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/BestPractices.html\">Using Cost Allocation Tags in Amazon ElastiCache</a>.</p>"
|
||||
},
|
||||
"ModifyCacheCluster":{
|
||||
"name":"ModifyCacheCluster",
|
||||
|
|
@ -582,7 +585,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>ModifyCacheCluster</i> action modifies the settings for a cache cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values.</p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"ModifyCacheParameterGroup":{
|
||||
"name":"ModifyCacheParameterGroup",
|
||||
|
|
@ -601,7 +604,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>ModifyCacheParameterGroup</i> action modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.</p>"
|
||||
"documentation":"<p>Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.</p>"
|
||||
},
|
||||
"ModifyCacheSubnetGroup":{
|
||||
"name":"ModifyCacheSubnetGroup",
|
||||
|
|
@ -620,7 +623,7 @@
|
|||
{"shape":"SubnetInUse"},
|
||||
{"shape":"InvalidSubnet"}
|
||||
],
|
||||
"documentation":"<p>The <i>ModifyCacheSubnetGroup</i> action modifies an existing cache subnet group.</p>"
|
||||
"documentation":"<p>Modifies an existing cache subnet group.</p>"
|
||||
},
|
||||
"ModifyReplicationGroup":{
|
||||
"name":"ModifyReplicationGroup",
|
||||
|
|
@ -648,7 +651,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>ModifyReplicationGroup</i> action modifies the settings for a replication group.</p>"
|
||||
"documentation":"<p>Modifies the settings for a replication group.</p> <important> <p>Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.</p> </important> <note> <p>This operation is valid for Redis only.</p> </note>"
|
||||
},
|
||||
"PurchaseReservedCacheNodesOffering":{
|
||||
"name":"PurchaseReservedCacheNodesOffering",
|
||||
|
|
@ -668,7 +671,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>PurchaseReservedCacheNodesOffering</i> action allows you to purchase a reserved cache node offering.</p>"
|
||||
"documentation":"<p>Allows you to purchase a reserved cache node offering.</p>"
|
||||
},
|
||||
"RebootCacheCluster":{
|
||||
"name":"RebootCacheCluster",
|
||||
|
|
@ -685,7 +688,7 @@
|
|||
{"shape":"InvalidCacheClusterStateFault"},
|
||||
{"shape":"CacheClusterNotFoundFault"}
|
||||
],
|
||||
"documentation":"<p>The <i>RebootCacheCluster</i> action 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.</p> <p>The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.</p> <p>When the reboot is complete, a cache cluster event is created.</p>"
|
||||
"documentation":"<p>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.</p> <p>The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.</p> <p>When the reboot is complete, a cache cluster event is created.</p>"
|
||||
},
|
||||
"RemoveTagsFromResource":{
|
||||
"name":"RemoveTagsFromResource",
|
||||
|
|
@ -704,7 +707,7 @@
|
|||
{"shape":"InvalidARNFault"},
|
||||
{"shape":"TagNotFoundFault"}
|
||||
],
|
||||
"documentation":"<p>The <i>RemoveTagsFromResource</i> action removes the tags identified by the <code>TagKeys</code> list from the named resource.</p>"
|
||||
"documentation":"<p>Removes the tags identified by the <code>TagKeys</code> list from the named resource.</p>"
|
||||
},
|
||||
"ResetCacheParameterGroup":{
|
||||
"name":"ResetCacheParameterGroup",
|
||||
|
|
@ -723,7 +726,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>ResetCacheParameterGroup</i> action 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 <i>ResetAllParameters</i> and <i>CacheParameterGroupName</i> parameters.</p>"
|
||||
"documentation":"<p>Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the <code>ResetAllParameters</code> and <code>CacheParameterGroupName</code> parameters.</p>"
|
||||
},
|
||||
"RevokeCacheSecurityGroupIngress":{
|
||||
"name":"RevokeCacheSecurityGroupIngress",
|
||||
|
|
@ -743,7 +746,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>The <i>RevokeCacheSecurityGroupIngress</i> action revokes ingress from a cache security group. Use this action to disallow access from an Amazon EC2 security group that had been previously authorized.</p>"
|
||||
"documentation":"<p>Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.</p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
|
|
@ -763,24 +766,20 @@
|
|||
"members":{
|
||||
"ResourceName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example <code>arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster</code> or <code>arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot</code>.</p> <p>For more information on ARNs, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example <code>arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster</code> or <code>arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot</code>.</p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of an <i>AddTagsToResource</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of an AddTagsToResource operation.</p>"
|
||||
},
|
||||
"AllowedNodeTypeModificationsMessage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ScaleUpModifications":{
|
||||
"shape":"NodeTypeList",
|
||||
"documentation":"<p>A string list, each element of which specifies a cache node type which you can use to scale your cache cluster or replication group.</p> <p>When scaling up a Redis cluster or replication group using <code>ModifyCacheCluster</code> or <code>ModifyReplicationGroup</code>, use a value from this list for the <i>CacheNodeType</i> parameter.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the allowed node types you can use to modify your cache cluster or replication group.</p>"
|
||||
"ScaleUpModifications":{"shape":"NodeTypeList"}
|
||||
}
|
||||
},
|
||||
"AuthorizationAlreadyExistsFault":{
|
||||
"type":"structure",
|
||||
|
|
@ -816,7 +815,7 @@
|
|||
"members":{
|
||||
"CacheSecurityGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The cache security group which will allow network ingress.</p>"
|
||||
"documentation":"<p>The cache security group that allows network ingress.</p>"
|
||||
},
|
||||
"EC2SecurityGroupName":{
|
||||
"shape":"String",
|
||||
|
|
@ -827,7 +826,7 @@
|
|||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of an <i>AuthorizeCacheSecurityGroupIngress</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of an AuthorizeCacheSecurityGroupIngress operation.</p>"
|
||||
},
|
||||
"AuthorizeCacheSecurityGroupIngressResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -879,11 +878,11 @@
|
|||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the compute and memory capacity node type for the cache cluster.</p> <p>Valid node types are as follows:</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized: <code>cache.c1.xlarge</code> </p> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Notes:</b> </p> <ul> <li> <p>All t2 instances are created in an Amazon Virtual Private Cloud (VPC).</p> </li> <li> <p>Redis backup/restore is not supported for t2 instances.</p> </li> <li> <p>Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.</p> </li> </ul> <p>For a complete listing of cache node types and specifications, see <a href=\"http://aws.amazon.com/elasticache/details\">Amazon ElastiCache Product Features and Details</a> and <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#CacheParameterGroups.Memcached.NodeSpecific\">Cache Node Type-Specific Parameters for Memcached</a> or <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#CacheParameterGroups.Redis.NodeSpecific\">Cache Node Type-Specific Parameters for Redis</a>.</p>"
|
||||
"documentation":"<p>The name of the compute and memory capacity node type for the cache cluster.</p> <p>Valid node types are as follows:</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code>, <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized: <code>cache.c1.xlarge</code> </p> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Notes:</b> </p> <ul> <li> <p>All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).</p> </li> <li> <p>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.</p> </li> <li> <p>Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.</p> </li> </ul> <p>For a complete listing of node types and specifications, see <a href=\"http://aws.amazon.com/elasticache/details\">Amazon ElastiCache Product Features and Details</a> and either <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#ParameterGroups.Memcached.NodeSpecific\">Cache Node Type-Specific Parameters for Memcached</a> or <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#ParameterGroups.Redis.NodeSpecific\">Cache Node Type-Specific Parameters for Redis</a>.</p>"
|
||||
},
|
||||
"Engine":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the cache engine (<i>memcached</i> or <i>redis</i>) to be used for this cache cluster.</p>"
|
||||
"documentation":"<p>The name of the cache engine (<code>memcached</code> or <code>redis</code>) to be used for this cache cluster.</p>"
|
||||
},
|
||||
"EngineVersion":{
|
||||
"shape":"String",
|
||||
|
|
@ -891,7 +890,7 @@
|
|||
},
|
||||
"CacheClusterStatus":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The current state of this cache cluster, one of the following values: <i>available</i>, <i>creating</i>, <i>deleted</i>, <i>deleting</i>, <i>incompatible-network</i>, <i>modifying</i>, <i>rebooting cache cluster nodes</i>, <i>restore-failed</i>, or <i>snapshotting</i>.</p>"
|
||||
"documentation":"<p>The current state of this cache cluster, one of the following values: <code>available</code>, <code>creating</code>, <code>deleted</code>, <code>deleting</code>, <code>incompatible-network</code>, <code>modifying</code>, <code>rebooting cache cluster nodes</code>, <code>restore-failed</code>, or <code>snapshotting</code>.</p>"
|
||||
},
|
||||
"NumCacheNodes":{
|
||||
"shape":"IntegerOptional",
|
||||
|
|
@ -907,7 +906,7 @@
|
|||
},
|
||||
"PreferredMaintenanceWindow":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>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 <code>ddd</code> are:</p> <ul> <li> <p> <code>sun</code> </p> </li> <li> <p> <code>mon</code> </p> </li> <li> <p> <code>tue</code> </p> </li> <li> <p> <code>wed</code> </p> </li> <li> <p> <code>thu</code> </p> </li> <li> <p> <code>fri</code> </p> </li> <li> <p> <code>sat</code> </p> </li> </ul> <p>Example: <code>sun:05:00-sun:09:00</code> </p>"
|
||||
"documentation":"<p>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.</p> <p>Valid values for <code>ddd</code> are:</p> <ul> <li> <p> <code>sun</code> </p> </li> <li> <p> <code>mon</code> </p> </li> <li> <p> <code>tue</code> </p> </li> <li> <p> <code>wed</code> </p> </li> <li> <p> <code>thu</code> </p> </li> <li> <p> <code>fri</code> </p> </li> <li> <p> <code>sat</code> </p> </li> </ul> <p>Example: <code>sun:23:00-mon:01:30</code> </p>"
|
||||
},
|
||||
"PendingModifiedValues":{"shape":"PendingModifiedValues"},
|
||||
"NotificationConfiguration":{"shape":"NotificationConfiguration"},
|
||||
|
|
@ -938,11 +937,11 @@
|
|||
},
|
||||
"SnapshotRetentionLimit":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set <i>SnapshotRetentionLimit</i> to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.</p> <important> <p> If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</p> </important>"
|
||||
"documentation":"<p>The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. For example, if you set <code>SnapshotRetentionLimit</code> to 5, a snapshot that was taken today is retained for 5 days before being deleted.</p> <important> <p> If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</p> </important>"
|
||||
},
|
||||
"SnapshotWindow":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.</p> <p>Example: <code>05:00-09:00</code> </p>"
|
||||
"documentation":"<p>The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cache cluster.</p> <p>Example: <code>05:00-09:00</code> </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains all of the attributes of a specific cache cluster.</p>",
|
||||
|
|
@ -979,7 +978,7 @@
|
|||
"documentation":"<p>A list of cache clusters. Each item in the list contains detailed information about one cache cluster.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a <i>DescribeCacheClusters</i> action.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>DescribeCacheClusters</code> operation.</p>"
|
||||
},
|
||||
"CacheClusterNotFoundFault":{
|
||||
"type":"structure",
|
||||
|
|
@ -1006,7 +1005,7 @@
|
|||
},
|
||||
"CacheParameterGroupFamily":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the cache parameter group family associated with this cache engine.</p>"
|
||||
"documentation":"<p>The name of the cache parameter group family associated with this cache engine.</p> <p>Valid values are: <code>memcached1.4</code> | <code>redis2.6</code> | <code>redis2.8</code> | <code>redis3.2</code> </p>"
|
||||
},
|
||||
"CacheEngineDescription":{
|
||||
"shape":"String",
|
||||
|
|
@ -1038,7 +1037,7 @@
|
|||
"documentation":"<p>A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a <a>DescribeCacheEngineVersions</a> action.</p>"
|
||||
"documentation":"<p>Represents the output of a <a>DescribeCacheEngineVersions</a> operation.</p>"
|
||||
},
|
||||
"CacheNode":{
|
||||
"type":"structure",
|
||||
|
|
@ -1065,14 +1064,14 @@
|
|||
},
|
||||
"SourceCacheNodeId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>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.</p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"CustomerAvailabilityZone":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Availability Zone where this node was created and now resides.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>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.</p> <p>Valid node types are as follows:</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized: <code>cache.c1.xlarge</code> </p> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Notes:</b> </p> <ul> <li> <p>All t2 instances are created in an Amazon Virtual Private Cloud (VPC).</p> </li> <li> <p>Redis backup/restore is not supported for t2 instances.</p> </li> <li> <p>Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.</p> </li> </ul> <p>For a complete listing of cache node types and specifications, see <a href=\"http://aws.amazon.com/elasticache/details\">Amazon ElastiCache Product Features and Details</a> and either <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#CacheParameterGroups.Memcached.NodeSpecific\">Cache Node Type-Specific Parameters for Memcached</a> or <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#CacheParameterGroups.Redis.NodeSpecific\">Cache Node Type-Specific Parameters for Redis</a>.</p>"
|
||||
"documentation":"<p>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.</p> <p>Valid node types are as follows:</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code>, <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized: <code>cache.c1.xlarge</code> </p> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Notes:</b> </p> <ul> <li> <p>All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).</p> </li> <li> <p>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.</p> </li> <li> <p>Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.</p> </li> </ul> <p>For a complete listing of node types and specifications, see <a href=\"http://aws.amazon.com/elasticache/details\">Amazon ElastiCache Product Features and Details</a> and either <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#ParameterGroups.Memcached.NodeSpecific\">Cache Node Type-Specific Parameters for Memcached</a> or <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#ParameterGroups.Redis.NodeSpecific\">Cache Node Type-Specific Parameters for Redis</a>.</p>"
|
||||
},
|
||||
"CacheNodeIdsList":{
|
||||
"type":"list",
|
||||
|
|
@ -1125,10 +1124,10 @@
|
|||
},
|
||||
"ChangeType":{
|
||||
"shape":"ChangeType",
|
||||
"documentation":"<p>ChangeType indicates whether a change to the parameter will be 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 <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Clusters.Rebooting.html\">Rebooting a Cluster</a>.</p>"
|
||||
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Clusters.Rebooting.html\">Rebooting a Cluster</a>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cache cluster, a <i>cache.m1.large</i> cache node type would have a larger <i>maxmemory</i> value than a <i>cache.m1.small</i> type.</p>"
|
||||
"documentation":"<p>A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cache cluster, a <code>cache.m1.large</code> cache node type would have a larger <code>maxmemory</code> value than a <code>cache.m1.small</code> type.</p>"
|
||||
},
|
||||
"CacheNodeTypeSpecificParametersList":{
|
||||
"type":"list",
|
||||
|
|
@ -1167,14 +1166,14 @@
|
|||
},
|
||||
"CacheParameterGroupFamily":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the cache parameter group family that this cache parameter group is compatible with.</p>"
|
||||
"documentation":"<p>The name of the cache parameter group family that this cache parameter group is compatible with.</p> <p>Valid values are: <code>memcached1.4</code> | <code>redis2.6</code> | <code>redis2.8</code> | <code>redis3.2</code> </p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The description for this cache parameter group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a <i>CreateCacheParameterGroup</i> action.</p>",
|
||||
"documentation":"<p>Represents the output of a <code>CreateCacheParameterGroup</code> operation.</p>",
|
||||
"wrapper":true
|
||||
},
|
||||
"CacheParameterGroupAlreadyExistsFault":{
|
||||
|
|
@ -1205,7 +1204,7 @@
|
|||
"documentation":"<p>A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a <i>DescribeCacheParameters</i> action.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>DescribeCacheParameters</code> operation.</p>"
|
||||
},
|
||||
"CacheParameterGroupList":{
|
||||
"type":"list",
|
||||
|
|
@ -1222,7 +1221,7 @@
|
|||
"documentation":"<p>The name of the cache parameter group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of one of the following actions:</p> <ul> <li> <p> <i>ModifyCacheParameterGroup</i> </p> </li> <li> <p> <i>ResetCacheParameterGroup</i> </p> </li> </ul>"
|
||||
"documentation":"<p>Represents the output of one of the following operations:</p> <ul> <li> <p> <code>ModifyCacheParameterGroup</code> </p> </li> <li> <p> <code>ResetCacheParameterGroup</code> </p> </li> </ul>"
|
||||
},
|
||||
"CacheParameterGroupNotFoundFault":{
|
||||
"type":"structure",
|
||||
|
|
@ -1264,7 +1263,7 @@
|
|||
"documentation":"<p>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.).</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The status of the cache parameter group.</p>"
|
||||
"documentation":"<p>Status of the cache parameter group.</p>"
|
||||
},
|
||||
"CacheParameterGroupsMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -1278,7 +1277,7 @@
|
|||
"documentation":"<p>A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a <i>DescribeCacheParameterGroups</i> action.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>DescribeCacheParameterGroups</code> operation.</p>"
|
||||
},
|
||||
"CacheSecurityGroup":{
|
||||
"type":"structure",
|
||||
|
|
@ -1300,7 +1299,7 @@
|
|||
"documentation":"<p>A list of Amazon EC2 security groups that are associated with this cache security group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of one of the following actions:</p> <ul> <li> <p> <i>AuthorizeCacheSecurityGroupIngress</i> </p> </li> <li> <p> <i>CreateCacheSecurityGroup</i> </p> </li> <li> <p> <i>RevokeCacheSecurityGroupIngress</i> </p> </li> </ul>",
|
||||
"documentation":"<p>Represents the output of one of the following operations:</p> <ul> <li> <p> <code>AuthorizeCacheSecurityGroupIngress</code> </p> </li> <li> <p> <code>CreateCacheSecurityGroup</code> </p> </li> <li> <p> <code>RevokeCacheSecurityGroupIngress</code> </p> </li> </ul>",
|
||||
"wrapper":true
|
||||
},
|
||||
"CacheSecurityGroupAlreadyExistsFault":{
|
||||
|
|
@ -1348,7 +1347,7 @@
|
|||
"documentation":"<p>A list of cache security groups. Each element in the list contains detailed information about one group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a <i>DescribeCacheSecurityGroups</i> action.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>DescribeCacheSecurityGroups</code> operation.</p>"
|
||||
},
|
||||
"CacheSecurityGroupNameList":{
|
||||
"type":"list",
|
||||
|
|
@ -1408,7 +1407,7 @@
|
|||
"documentation":"<p>A list of subnets associated with the cache subnet group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of one of the following actions:</p> <ul> <li> <p> <i>CreateCacheSubnetGroup</i> </p> </li> <li> <p> <i>ModifyCacheSubnetGroup</i> </p> </li> </ul>",
|
||||
"documentation":"<p>Represents the output of one of the following operations:</p> <ul> <li> <p> <code>CreateCacheSubnetGroup</code> </p> </li> <li> <p> <code>ModifyCacheSubnetGroup</code> </p> </li> </ul>",
|
||||
"wrapper":true
|
||||
},
|
||||
"CacheSubnetGroupAlreadyExistsFault":{
|
||||
|
|
@ -1447,7 +1446,7 @@
|
|||
"documentation":"<p>A list of cache subnet groups. Each element in the list contains detailed information about one group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a <i>DescribeCacheSubnetGroups</i> action.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>DescribeCacheSubnetGroups</code> operation.</p>"
|
||||
},
|
||||
"CacheSubnetGroupNotFoundFault":{
|
||||
"type":"structure",
|
||||
|
|
@ -1531,14 +1530,14 @@
|
|||
},
|
||||
"TargetSnapshotName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>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.</p> <p class=\"title\"> <b>Error Message</b> </p> <ul> <li> <p> <b>Error Message:</b> The S3 bucket %s already contains an object with key %s.</p> <p> <b>Solution:</b> Give the <i>TargetSnapshotName</i> a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for <i>TargetSnapshotName</i>.</p> </li> </ul>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"TargetBucket":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon S3 bucket to which the snapshot will be exported. This parameter is used only when exporting a snapshot for external access.</p> <p>When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/AmazonElastiCache/latest/UserGuide/Snapshots.Exporting.html#Snapshots.Exporting.GrantAccess\">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the <i>Amazon ElastiCache User Guide</i>.</p> <p> <b>Error Messages:</b> </p> <p>You could receive one of the following error messages.</p> <p class=\"title\"> <b>Erorr Messages</b> </p> <ul> <li> <p> <b>Error Message: </b> ElastiCache has not been granted READ permissions %s on the S3 Bucket.</p> <p> <b>Solution:</b> Add List and Read permissions on the bucket.</p> </li> <li> <p> <b>Error Message: </b> ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.</p> <p> <b>Solution:</b> Add Upload/Delete permissions on the bucket.</p> </li> <li> <p> <b>Error Message: </b> ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.</p> <p> <b>Solution:</b> Add View Permissions permissions on the bucket.</p> </li> <li> <p> <b>Error Message:</b> The S3 bucket %s is outside of the region.</p> <p> <b>Solution:</b> Before exporting your snapshot, create a new Amazon S3 bucket in the same region as your snapshot. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Snapshots.Exporting.html#Snapshots.Exporting.CreateBucket\">Step 1: Create an Amazon S3 Bucket</a>.</p> </li> <li> <p> <b>Error Message:</b> The S3 bucket %s does not exist.</p> <p> <b>Solution:</b> Create an Amazon S3 bucket in the same region as your snapshot. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Snapshots.Exporting.html#Snapshots.Exporting.CreateBucket\">Step 1: Create an Amazon S3 Bucket</a>.</p> </li> <li> <p> <b>Error Message:</b> The S3 bucket %s is not owned by the authenticated user.</p> <p> <b>Solution:</b> Create an Amazon S3 bucket in the same region as your snapshot. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Snapshots.Exporting.html#Snapshots.Exporting.CreateBucket\">Step 1: Create an Amazon S3 Bucket</a>.</p> </li> <li> <p> <b>Error Message:</b> The authenticated user does not have sufficient permissions to perform the desired activity.</p> <p> <b>Solution:</b> Contact your system administrator to get the needed permissions.</p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Snapshots.Exporting.html\">Exporting a Snapshot</a> in the <i>Amazon ElastiCache User Guide</i>.</p>"
|
||||
"documentation":"<p>The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.</p> <p>When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Snapshots.Exporting.html#Snapshots.Exporting.GrantAccess\">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the <i>Amazon ElastiCache User Guide</i>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Snapshots.Exporting.html\">Exporting a Snapshot</a> in the <i>Amazon ElastiCache User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>CopySnapshotMessage</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>CopySnapshotMessage</code> operation.</p>"
|
||||
},
|
||||
"CopySnapshotResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1552,55 +1551,55 @@
|
|||
"members":{
|
||||
"CacheClusterId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The node group identifier. This parameter is stored as a lowercase string.</p> <p> <b>Constraints:</b> </p> <ul> <li> <p>A name must contain from 1 to 20 alphanumeric characters or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>A name cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
|
||||
"documentation":"<p>The node group (shard) identifier. This parameter is stored as a lowercase string.</p> <p> <b>Constraints:</b> </p> <ul> <li> <p>A name must contain from 1 to 20 alphanumeric characters or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>A name cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
|
||||
},
|
||||
"ReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>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.</p> <p>If the specified replication group is Multi-AZ 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.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note>"
|
||||
"documentation":"<important> <p>Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.</p> </important> <p>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.</p> <p>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.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note>"
|
||||
},
|
||||
"AZMode":{
|
||||
"shape":"AZMode",
|
||||
"documentation":"<p>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.</p> <p>This parameter is only supported for Memcached cache clusters.</p> <p>If the <code>AZMode</code> and <code>PreferredAvailabilityZones</code> are not specified, ElastiCache assumes <code>single-az</code> mode.</p>"
|
||||
"documentation":"<p>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.</p> <p>This parameter is only supported for Memcached cache clusters.</p> <p>If the <code>AZMode</code> and <code>PreferredAvailabilityZones</code> are not specified, ElastiCache assumes <code>single-az</code> mode.</p>"
|
||||
},
|
||||
"PreferredAvailabilityZone":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The EC2 Availability Zone in which the cache cluster will be created.</p> <p>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 <code>PreferredAvailabilityZones</code>.</p> <p>Default: System chosen Availability Zone.</p>"
|
||||
"documentation":"<p>The EC2 Availability Zone in which the cache cluster is created.</p> <p>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 <code>PreferredAvailabilityZones</code>.</p> <p>Default: System chosen Availability Zone.</p>"
|
||||
},
|
||||
"PreferredAvailabilityZones":{
|
||||
"shape":"PreferredAvailabilityZoneList",
|
||||
"documentation":"<p>A list of the Availability Zones in which cache nodes will be created. The order of the zones in the list is not important.</p> <p>This option is only supported on Memcached.</p> <note> <p>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.</p> <p>The number of Availability Zones listed must equal the value of <code>NumCacheNodes</code>.</p> </note> <p>If you want all the nodes in the same Availability Zone, use <code>PreferredAvailabilityZone</code> instead, or repeat the Availability Zone multiple times in the list.</p> <p>Default: System chosen Availability Zones.</p> <p>Example: One Memcached node in each of three different Availability Zones: <code>PreferredAvailabilityZones.member.1=us-west-2a&amp;PreferredAvailabilityZones.member.2=us-west-2b&amp;PreferredAvailabilityZones.member.3=us-west-2c</code> </p> <p>Example: All three Memcached nodes in one Availability Zone: <code>PreferredAvailabilityZones.member.1=us-west-2a&amp;PreferredAvailabilityZones.member.2=us-west-2a&amp;PreferredAvailabilityZones.member.3=us-west-2a</code> </p>"
|
||||
"documentation":"<p>A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.</p> <p>This option is only supported on Memcached.</p> <note> <p>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.</p> <p>The number of Availability Zones listed must equal the value of <code>NumCacheNodes</code>.</p> </note> <p>If you want all the nodes in the same Availability Zone, use <code>PreferredAvailabilityZone</code> instead, or repeat the Availability Zone multiple times in the list.</p> <p>Default: System chosen Availability Zones.</p>"
|
||||
},
|
||||
"NumCacheNodes":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The initial number of cache nodes that the cache cluster will have.</p> <p>For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.</p> <p>If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at <a href=\"http://aws.amazon.com/contact-us/elasticache-node-limit-request/\">http://aws.amazon.com/contact-us/elasticache-node-limit-request/</a>.</p>"
|
||||
"documentation":"<p>The initial number of cache nodes that the cache cluster has.</p> <p>For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.</p> <p>If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at <a href=\"http://aws.amazon.com/contact-us/elasticache-node-limit-request/\">http://aws.amazon.com/contact-us/elasticache-node-limit-request/</a>.</p>"
|
||||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The compute and memory capacity of the nodes in the node group.</p> <p>Valid node types are as follows:</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized: <code>cache.c1.xlarge</code> </p> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Notes:</b> </p> <ul> <li> <p>All t2 instances are created in an Amazon Virtual Private Cloud (VPC).</p> </li> <li> <p>Redis backup/restore is not supported for t2 instances.</p> </li> <li> <p>Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.</p> </li> </ul> <p>For a complete listing of cache node types and specifications, see <a href=\"http://aws.amazon.com/elasticache/details\">Amazon ElastiCache Product Features and Details</a> and <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#CacheParameterGroups.Memcached.NodeSpecific\">Cache Node Type-Specific Parameters for Memcached</a> or <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#CacheParameterGroups.Redis.NodeSpecific\">Cache Node Type-Specific Parameters for Redis</a>.</p>"
|
||||
"documentation":"<p>The compute and memory capacity of the nodes in the node group (shard).</p> <p>Valid node types are as follows:</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code>, <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized: <code>cache.c1.xlarge</code> </p> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Notes:</b> </p> <ul> <li> <p>All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).</p> </li> <li> <p>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.</p> </li> <li> <p>Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.</p> </li> </ul> <p>For a complete listing of node types and specifications, see <a href=\"http://aws.amazon.com/elasticache/details\">Amazon ElastiCache Product Features and Details</a> and either <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#ParameterGroups.Memcached.NodeSpecific\">Cache Node Type-Specific Parameters for Memcached</a> or <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#ParameterGroups.Redis.NodeSpecific\">Cache Node Type-Specific Parameters for Redis</a>.</p>"
|
||||
},
|
||||
"Engine":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the cache engine to be used for this cache cluster.</p> <p>Valid values for this parameter are:</p> <p> <code>memcached</code> | <code>redis</code> </p>"
|
||||
"documentation":"<p>The name of the cache engine to be used for this cache cluster.</p> <p>Valid values for this parameter are: <code>memcached</code> | <code>redis</code> </p>"
|
||||
},
|
||||
"EngineVersion":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The version number of the cache engine to be used for this cache cluster. To view the supported cache engine versions, use the <i>DescribeCacheEngineVersions</i> action.</p> <p> <b>Important:</b> You can upgrade to a newer engine version (see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/SelectEngine.html#VersionManagement\">Selecting a Cache Engine and Version</a>), 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. </p>"
|
||||
"documentation":"<p>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.</p> <p> <b>Important:</b> You can upgrade to a newer engine version (see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/SelectEngine.html#VersionManagement\">Selecting a Cache Engine and Version</a>), 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. </p>"
|
||||
},
|
||||
"CacheParameterGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>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.</p>"
|
||||
"documentation":"<p>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 <code>cluster-enabled='yes'</code> when creating a cluster.</p>"
|
||||
},
|
||||
"CacheSubnetGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the subnet group to be used for the cache cluster.</p> <p>Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).</p>"
|
||||
"documentation":"<p>The name of the subnet group to be used for the cache cluster.</p> <p>Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (Amazon VPC).</p> <important> <p>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 <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/SubnetGroups.html\">Subnets and Subnet Groups</a>.</p> </important>"
|
||||
},
|
||||
"CacheSecurityGroupNames":{
|
||||
"shape":"CacheSecurityGroupNameList",
|
||||
"documentation":"<p>A list of security group names to associate with this cache cluster.</p> <p>Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).</p>"
|
||||
"documentation":"<p>A list of security group names to associate with this cache cluster.</p> <p>Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).</p>"
|
||||
},
|
||||
"SecurityGroupIds":{
|
||||
"shape":"SecurityGroupIdsList",
|
||||
"documentation":"<p>One or more VPC security groups associated with the cache cluster.</p> <p>Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).</p>"
|
||||
"documentation":"<p>One or more VPC security groups associated with the cache cluster.</p> <p>Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (Amazon VPC).</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
|
|
@ -1608,23 +1607,23 @@
|
|||
},
|
||||
"SnapshotArns":{
|
||||
"shape":"SnapshotArnsList",
|
||||
"documentation":"<p>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.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note> <p>Example of an Amazon S3 ARN: <code>arn:aws:s3:::my_bucket/snapshot1.rdb</code> </p>"
|
||||
"documentation":"<p>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.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note> <p>Example of an Amazon S3 ARN: <code>arn:aws:s3:::my_bucket/snapshot1.rdb</code> </p>"
|
||||
},
|
||||
"SnapshotName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of a snapshot from which to restore data into the new node group. The snapshot status changes to <code>restoring</code> while the new node group is being created.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note>"
|
||||
"documentation":"<p>The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to <code>restoring</code> while the new node group (shard) is being created.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note>"
|
||||
},
|
||||
"PreferredMaintenanceWindow":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>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 <code>ddd</code> are:</p> <ul> <li> <p> <code>sun</code> </p> </li> <li> <p> <code>mon</code> </p> </li> <li> <p> <code>tue</code> </p> </li> <li> <p> <code>wed</code> </p> </li> <li> <p> <code>thu</code> </p> </li> <li> <p> <code>fri</code> </p> </li> <li> <p> <code>sat</code> </p> </li> </ul> <p>Example: <code>sun:05:00-sun:09:00</code> </p>"
|
||||
"documentation":"<p>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 <code>ddd</code> are:</p> <p>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.</p> <p>Valid values for <code>ddd</code> are:</p> <ul> <li> <p> <code>sun</code> </p> </li> <li> <p> <code>mon</code> </p> </li> <li> <p> <code>tue</code> </p> </li> <li> <p> <code>wed</code> </p> </li> <li> <p> <code>thu</code> </p> </li> <li> <p> <code>fri</code> </p> </li> <li> <p> <code>sat</code> </p> </li> </ul> <p>Example: <code>sun:23:00-mon:01:30</code> </p>"
|
||||
},
|
||||
"Port":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The port number on which each of the cache nodes will accept connections.</p>"
|
||||
"documentation":"<p>The port number on which each of the cache nodes accepts connections.</p>"
|
||||
},
|
||||
"NotificationTopicArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.</p> <note> <p>The Amazon SNS topic owner must be the same as the cache cluster owner.</p> </note>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.</p> <note> <p>The Amazon SNS topic owner must be the same as the cache cluster owner.</p> </note>"
|
||||
},
|
||||
"AutoMinorVersionUpgrade":{
|
||||
"shape":"BooleanOptional",
|
||||
|
|
@ -1632,14 +1631,14 @@
|
|||
},
|
||||
"SnapshotRetentionLimit":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set <code>SnapshotRetentionLimit</code> to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note> <p>Default: 0 (i.e., automatic backups are disabled for this cache cluster).</p>"
|
||||
"documentation":"<p>The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set <code>SnapshotRetentionLimit</code> to 5, a snapshot taken today is retained for 5 days before being deleted.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note> <p>Default: 0 (i.e., automatic backups are disabled for this cache cluster).</p>"
|
||||
},
|
||||
"SnapshotWindow":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.</p> <p>Example: <code>05:00-09:00</code> </p> <p>If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.</p> <p> <b>Note:</b> This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p>"
|
||||
"documentation":"<p>The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).</p> <p>Example: <code>05:00-09:00</code> </p> <p>If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.</p> <p> <b>Note:</b> This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>CreateCacheCluster</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a CreateCacheCluster operation.</p>"
|
||||
},
|
||||
"CreateCacheClusterResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1661,14 +1660,14 @@
|
|||
},
|
||||
"CacheParameterGroupFamily":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the cache parameter group family the cache parameter group can be used with.</p> <p>Valid values are: <code>memcached1.4</code> | <code>redis2.6</code> | <code>redis2.8</code> </p>"
|
||||
"documentation":"<p>The name of the cache parameter group family that the cache parameter group can be used with.</p> <p>Valid values are: <code>memcached1.4</code> | <code>redis2.6</code> | <code>redis2.8</code> | <code>redis3.2</code> </p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A user-specified description for the cache parameter group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>CreateCacheParameterGroup</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>CreateCacheParameterGroup</code> operation.</p>"
|
||||
},
|
||||
"CreateCacheParameterGroupResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1692,7 +1691,7 @@
|
|||
"documentation":"<p>A description for the cache security group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>CreateCacheSecurityGroup</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>CreateCacheSecurityGroup</code> operation.</p>"
|
||||
},
|
||||
"CreateCacheSecurityGroupResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1721,7 +1720,7 @@
|
|||
"documentation":"<p>A list of VPC subnet IDs for the cache subnet group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>CreateCacheSubnetGroup</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>CreateCacheSubnetGroup</code> operation.</p>"
|
||||
},
|
||||
"CreateCacheSubnetGroupResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1746,39 +1745,51 @@
|
|||
},
|
||||
"PrimaryClusterId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>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 <i>available</i>.</p> <p>This parameter is not required if <i>NumCacheClusters</i> is specified.</p>"
|
||||
"documentation":"<p>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 <code>available</code>.</p> <p>This parameter is not required if <code>NumCacheClusters</code>, <code>NumNodeGroups</code>, or <code>ReplicasPerNodeGroup</code> is specified.</p>"
|
||||
},
|
||||
"AutomaticFailoverEnabled":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.</p> <p>If <code>true</code>, Multi-AZ is enabled for this replication group. If <code>false</code>, Multi-AZ is disabled for this replication group.</p> <p>Default: false</p> <note> <p>ElastiCache Multi-AZ replication groups is not supported on:</p> <ul> <li> <p>Redis versions earlier than 2.8.6.</p> </li> <li> <p>T1 and T2 cache node types.</p> </li> </ul> </note>"
|
||||
"documentation":"<p>Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.</p> <p>If <code>true</code>, Multi-AZ is enabled for this replication group. If <code>false</code>, Multi-AZ is disabled for this replication group.</p> <p> <code>AutomaticFailoverEnabled</code> must be enabled for Redis (cluster mode enabled) replication groups.</p> <p>Default: false</p> <note> <p>ElastiCache Multi-AZ replication groups is not supported on:</p> <ul> <li> <p>Redis versions earlier than 2.8.6.</p> </li> <li> <p>Redis (cluster mode disabled): T1 and T2 node types.</p> <p>Redis (cluster mode enabled): T2 node types.</p> </li> </ul> </note>"
|
||||
},
|
||||
"NumCacheClusters":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The number of cache clusters this replication group will initially have.</p> <p>If <i>Multi-AZ</i> is <code>enabled</code>, the value of this parameter must be at least 2.</p> <p>The maximum permitted value for <i>NumCacheClusters</i> is 6 (primary plus 5 replicas). If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at <a href=\"http://aws.amazon.com/contact-us/elasticache-node-limit-request\">http://aws.amazon.com/contact-us/elasticache-node-limit-request</a>.</p>"
|
||||
"documentation":"<p>The number of clusters this replication group initially has.</p> <p>This parameter is not used if there is more than one node group (shard). You should use <code>ReplicasPerNodeGroup</code> instead.</p> <p>If <code>Multi-AZ</code> is <code>enabled</code>, the value of this parameter must be at least 2.</p> <p>The maximum permitted value for <code>NumCacheClusters</code> is 6 (primary plus 5 replicas). If you need to exceed this limit, fill out the ElastiCache Limit Increase Request form at <a href=\"http://aws.amazon.com/contact-us/elasticache-node-limit-request/\">http://aws.amazon.com/contact-us/elasticache-node-limit-request/</a>.</p>"
|
||||
},
|
||||
"PreferredCacheClusterAZs":{
|
||||
"shape":"AvailabilityZonesList",
|
||||
"documentation":"<p>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.</p> <note> <p>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.</p> <p>The number of availability zones listed must equal the value of <i>NumCacheClusters</i>.</p> </note> <p>Default: system chosen availability zones.</p> <p>Example: One Redis cache cluster in each of three availability zones. </p> <p> <code>PreferredAvailabilityZones.member.1=us-west-2a PreferredAvailabilityZones.member.2=us-west-2c PreferredAvailabilityZones.member.3=us-west-2c</code> </p>"
|
||||
"documentation":"<p>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.</p> <p>This parameter is not used if there is more than one node group (shard). You should use <code>NodeGroupConfiguration</code> instead.</p> <note> <p>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.</p> <p>The number of Availability Zones listed must equal the value of <code>NumCacheClusters</code>.</p> </note> <p>Default: system chosen Availability Zones.</p>"
|
||||
},
|
||||
"NumNodeGroups":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>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.</p> <p>Default: 1</p>"
|
||||
},
|
||||
"ReplicasPerNodeGroup":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.</p>"
|
||||
},
|
||||
"NodeGroupConfiguration":{
|
||||
"shape":"NodeGroupConfigurationList",
|
||||
"documentation":"<p>A list of node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.</p> <p>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.</p>"
|
||||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The compute and memory capacity of the nodes in the node group.</p> <p>Valid node types are as follows:</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized: <code>cache.c1.xlarge</code> </p> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Notes:</b> </p> <ul> <li> <p>All t2 instances are created in an Amazon Virtual Private Cloud (VPC).</p> </li> <li> <p>Redis backup/restore is not supported for t2 instances.</p> </li> <li> <p>Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.</p> </li> </ul> <p>For a complete listing of cache node types and specifications, see <a href=\"http://aws.amazon.com/elasticache/details\">Amazon ElastiCache Product Features and Details</a> and <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#CacheParameterGroups.Memcached.NodeSpecific\">Cache Node Type-Specific Parameters for Memcached</a> or <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#CacheParameterGroups.Redis.NodeSpecific\">Cache Node Type-Specific Parameters for Redis</a>.</p>"
|
||||
"documentation":"<p>The compute and memory capacity of the nodes in the node group (shard).</p> <p>Valid node types are as follows:</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code>, <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized: <code>cache.c1.xlarge</code> </p> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Notes:</b> </p> <ul> <li> <p>All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).</p> </li> <li> <p>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.</p> </li> <li> <p>Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.</p> </li> </ul> <p>For a complete listing of node types and specifications, see <a href=\"http://aws.amazon.com/elasticache/details\">Amazon ElastiCache Product Features and Details</a> and either <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#ParameterGroups.Memcached.NodeSpecific\">Cache Node Type-Specific Parameters for Memcached</a> or <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#ParameterGroups.Redis.NodeSpecific\">Cache Node Type-Specific Parameters for Redis</a>.</p>"
|
||||
},
|
||||
"Engine":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the cache engine to be used for the cache clusters in this replication group.</p> <p>Default: redis</p>"
|
||||
"documentation":"<p>The name of the cache engine to be used for the cache clusters in this replication group.</p>"
|
||||
},
|
||||
"EngineVersion":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>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 <i>DescribeCacheEngineVersions</i> action.</p> <p> <b>Important:</b> You can upgrade to a newer engine version (see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/SelectEngine.html#VersionManagement\">Selecting a Cache Engine and Version</a>) in the <i>ElastiCache User Guide</i>, 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. </p>"
|
||||
"documentation":"<p>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 <code>DescribeCacheEngineVersions</code> operation.</p> <p> <b>Important:</b> You can upgrade to a newer engine version (see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/SelectEngine.html#VersionManagement\">Selecting a Cache Engine and Version</a>) in the <i>ElastiCache User Guide</i>, 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. </p>"
|
||||
},
|
||||
"CacheParameterGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>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.</p>"
|
||||
"documentation":"<p>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.</p> <p>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. </p> <ul> <li> <p>To create a Redis (cluster mode disabled) replication group, use <code>CacheParameterGroupName=default.redis3.2</code>.</p> </li> <li> <p>To create a Redis (cluster mode enabled) replication group, use <code>CacheParameterGroupName=default.redis3.2.cluster.on</code>.</p> </li> </ul>"
|
||||
},
|
||||
"CacheSubnetGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the cache subnet group to be used for the replication group.</p>"
|
||||
"documentation":"<p>The name of the cache subnet group to be used for the replication group.</p> <important> <p>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 <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/SubnetGroups.html\">Subnets and Subnet Groups</a>.</p> </important>"
|
||||
},
|
||||
"CacheSecurityGroupNames":{
|
||||
"shape":"CacheSecurityGroupNameList",
|
||||
|
|
@ -1786,7 +1797,7 @@
|
|||
},
|
||||
"SecurityGroupIds":{
|
||||
"shape":"SecurityGroupIdsList",
|
||||
"documentation":"<p>One or more Amazon VPC security groups associated with this replication group.</p> <p>Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (VPC).</p>"
|
||||
"documentation":"<p>One or more Amazon VPC security groups associated with this replication group.</p> <p>Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
|
|
@ -1794,23 +1805,23 @@
|
|||
},
|
||||
"SnapshotArns":{
|
||||
"shape":"SnapshotArnsList",
|
||||
"documentation":"<p>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.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note> <p>Example of an Amazon S3 ARN: <code>arn:aws:s3:::my_bucket/snapshot1.rdb</code> </p>"
|
||||
"documentation":"<p>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.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note> <p>Example of an Amazon S3 ARN: <code>arn:aws:s3:::my_bucket/snapshot1.rdb</code> </p>"
|
||||
},
|
||||
"SnapshotName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of a snapshot from which to restore data into the new node group. The snapshot status changes to <code>restoring</code> while the new node group is being created.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note>"
|
||||
"documentation":"<p>The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to <code>restoring</code> while the new replication group is being created.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note>"
|
||||
},
|
||||
"PreferredMaintenanceWindow":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>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 <code>ddd</code> are:</p> <ul> <li> <p> <code>sun</code> </p> </li> <li> <p> <code>mon</code> </p> </li> <li> <p> <code>tue</code> </p> </li> <li> <p> <code>wed</code> </p> </li> <li> <p> <code>thu</code> </p> </li> <li> <p> <code>fri</code> </p> </li> <li> <p> <code>sat</code> </p> </li> </ul> <p>Example: <code>sun:05:00-sun:09:00</code> </p>"
|
||||
"documentation":"<p>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 <code>ddd</code> are:</p> <p>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.</p> <p>Valid values for <code>ddd</code> are:</p> <ul> <li> <p> <code>sun</code> </p> </li> <li> <p> <code>mon</code> </p> </li> <li> <p> <code>tue</code> </p> </li> <li> <p> <code>wed</code> </p> </li> <li> <p> <code>thu</code> </p> </li> <li> <p> <code>fri</code> </p> </li> <li> <p> <code>sat</code> </p> </li> </ul> <p>Example: <code>sun:23:00-mon:01:30</code> </p>"
|
||||
},
|
||||
"Port":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The port number on which each member of the replication group will accept connections.</p>"
|
||||
"documentation":"<p>The port number on which each member of the replication group accepts connections.</p>"
|
||||
},
|
||||
"NotificationTopicArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.</p> <note> <p>The Amazon SNS topic owner must be the same as the cache cluster owner.</p> </note>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.</p> <note> <p>The Amazon SNS topic owner must be the same as the cache cluster owner.</p> </note>"
|
||||
},
|
||||
"AutoMinorVersionUpgrade":{
|
||||
"shape":"BooleanOptional",
|
||||
|
|
@ -1818,14 +1829,14 @@
|
|||
},
|
||||
"SnapshotRetentionLimit":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set <code>SnapshotRetentionLimit</code> to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note> <p>Default: 0 (i.e., automatic backups are disabled for this cache cluster).</p>"
|
||||
"documentation":"<p>The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set <code>SnapshotRetentionLimit</code> to 5, a snapshot that was taken today is retained for 5 days before being deleted.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note> <p>Default: 0 (i.e., automatic backups are disabled for this cache cluster).</p>"
|
||||
},
|
||||
"SnapshotWindow":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.</p> <p>Example: <code>05:00-09:00</code> </p> <p>If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note>"
|
||||
"documentation":"<p>The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).</p> <p>Example: <code>05:00-09:00</code> </p> <p>If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.</p> <note> <p>This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p> </note>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>CreateReplicationGroup</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>CreateReplicationGroup</code> operation.</p>"
|
||||
},
|
||||
"CreateReplicationGroupResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1835,21 +1846,22 @@
|
|||
},
|
||||
"CreateSnapshotMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"CacheClusterId",
|
||||
"SnapshotName"
|
||||
],
|
||||
"required":["SnapshotName"],
|
||||
"members":{
|
||||
"ReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The identifier of an existing replication group. The snapshot is created from this replication group.</p>"
|
||||
},
|
||||
"CacheClusterId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The identifier of an existing cache cluster. The snapshot will be created from this cache cluster.</p>"
|
||||
"documentation":"<p>The identifier of an existing cache cluster. The snapshot is created from this cache cluster.</p>"
|
||||
},
|
||||
"SnapshotName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A name for the snapshot being created.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>CreateSnapshot</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>CreateSnapshot</code> operation.</p>"
|
||||
},
|
||||
"CreateSnapshotResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1870,7 +1882,7 @@
|
|||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>DeleteCacheCluster</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>DeleteCacheCluster</code> operation.</p>"
|
||||
},
|
||||
"DeleteCacheClusterResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1887,7 +1899,7 @@
|
|||
"documentation":"<p>The name of the cache parameter group to delete.</p> <note> <p>The specified cache security group must not be associated with any cache clusters.</p> </note>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>DeleteCacheParameterGroup</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>DeleteCacheParameterGroup</code> operation.</p>"
|
||||
},
|
||||
"DeleteCacheSecurityGroupMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -1898,7 +1910,7 @@
|
|||
"documentation":"<p>The name of the cache security group to delete.</p> <note> <p>You cannot delete the default security group.</p> </note>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>DeleteCacheSecurityGroup</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>DeleteCacheSecurityGroup</code> operation.</p>"
|
||||
},
|
||||
"DeleteCacheSubnetGroupMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -1909,7 +1921,7 @@
|
|||
"documentation":"<p>The name of the cache subnet group to delete.</p> <p>Constraints: Must contain no more than 255 alphanumeric characters or hyphens.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>DeleteCacheSubnetGroup</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>DeleteCacheSubnetGroup</code> operation.</p>"
|
||||
},
|
||||
"DeleteReplicationGroupMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -1921,14 +1933,14 @@
|
|||
},
|
||||
"RetainPrimaryCluster":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>If set to <i>true</i>, all of the read replicas will be deleted, but the primary node will be retained.</p>"
|
||||
"documentation":"<p>If set to <code>true</code>, all of the read replicas are deleted, but the primary node is retained.</p>"
|
||||
},
|
||||
"FinalSnapshotIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>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.</p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>DeleteReplicationGroup</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>DeleteReplicationGroup</code> operation.</p>"
|
||||
},
|
||||
"DeleteReplicationGroupResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1945,7 +1957,7 @@
|
|||
"documentation":"<p>The name of the snapshot to be deleted.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>DeleteSnapshot</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>DeleteSnapshot</code> operation.</p>"
|
||||
},
|
||||
"DeleteSnapshotResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1966,14 +1978,14 @@
|
|||
},
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</p>"
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
|
||||
},
|
||||
"ShowCacheNodeInfo":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>DescribeCacheClusters</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>DescribeCacheClusters</code> operation.</p>"
|
||||
},
|
||||
"DescribeCacheEngineVersionsMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -1988,7 +2000,7 @@
|
|||
},
|
||||
"CacheParameterGroupFamily":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of a specific cache parameter group family to return details for.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 alphanumeric characters</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens</p> </li> </ul>"
|
||||
"documentation":"<p>The name of a specific cache parameter group family to return details for.</p> <p>Valid values are: <code>memcached1.4</code> | <code>redis2.6</code> | <code>redis2.8</code> | <code>redis3.2</code> </p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 alphanumeric characters</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens</p> </li> </ul>"
|
||||
},
|
||||
"MaxRecords":{
|
||||
"shape":"IntegerOptional",
|
||||
|
|
@ -1996,14 +2008,14 @@
|
|||
},
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</p>"
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
|
||||
},
|
||||
"DefaultOnly":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>If <i>true</i>, specifies that only the default version of the specified engine or engine and major version combination is to be returned.</p>"
|
||||
"documentation":"<p>If <code>true</code>, specifies that only the default version of the specified engine or engine and major version combination is to be returned.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>DescribeCacheEngineVersions</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>DescribeCacheEngineVersions</code> operation.</p>"
|
||||
},
|
||||
"DescribeCacheParameterGroupsMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -2018,10 +2030,10 @@
|
|||
},
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</p>"
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>DescribeCacheParameterGroups</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>DescribeCacheParameterGroups</code> operation.</p>"
|
||||
},
|
||||
"DescribeCacheParametersMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -2037,14 +2049,14 @@
|
|||
},
|
||||
"MaxRecords":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The maximum number of brecords to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: minimum 20; maximum 100.</p>"
|
||||
"documentation":"<p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: minimum 20; maximum 100.</p>"
|
||||
},
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</p>"
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>DescribeCacheParameters</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>DescribeCacheParameters</code> operation.</p>"
|
||||
},
|
||||
"DescribeCacheSecurityGroupsMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -2059,10 +2071,10 @@
|
|||
},
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</p>"
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>DescribeCacheSecurityGroups</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>DescribeCacheSecurityGroups</code> operation.</p>"
|
||||
},
|
||||
"DescribeCacheSubnetGroupsMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -2077,10 +2089,10 @@
|
|||
},
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</p>"
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>DescribeCacheSubnetGroups</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>DescribeCacheSubnetGroups</code> operation.</p>"
|
||||
},
|
||||
"DescribeEngineDefaultParametersMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -2088,7 +2100,7 @@
|
|||
"members":{
|
||||
"CacheParameterGroupFamily":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the cache parameter group family. Valid values are: <code>memcached1.4</code> | <code>redis2.6</code> | <code>redis2.8</code> </p>"
|
||||
"documentation":"<p>The name of the cache parameter group family.</p> <p>Valid values are: <code>memcached1.4</code> | <code>redis2.6</code> | <code>redis2.8</code> | <code>redis3.2</code> </p>"
|
||||
},
|
||||
"MaxRecords":{
|
||||
"shape":"IntegerOptional",
|
||||
|
|
@ -2096,10 +2108,10 @@
|
|||
},
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</p>"
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>DescribeEngineDefaultParameters</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>DescribeEngineDefaultParameters</code> operation.</p>"
|
||||
},
|
||||
"DescribeEngineDefaultParametersResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -2112,11 +2124,11 @@
|
|||
"members":{
|
||||
"SourceIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.</p>"
|
||||
"documentation":"<p>The identifier of the event source for which events are returned. If not specified, all sources are included in the response.</p>"
|
||||
},
|
||||
"SourceType":{
|
||||
"shape":"SourceType",
|
||||
"documentation":"<p>The event source to retrieve events for. If no value is specified, all events are returned.</p> <p>Valid values are: <code>cache-cluster</code> | <code>cache-parameter-group</code> | <code>cache-security-group</code> | <code>cache-subnet-group</code> </p>"
|
||||
"documentation":"<p>The event source to retrieve events for. If no value is specified, all events are returned.</p>"
|
||||
},
|
||||
"StartTime":{
|
||||
"shape":"TStamp",
|
||||
|
|
@ -2136,10 +2148,10 @@
|
|||
},
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</p>"
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>DescribeEvents</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>DescribeEvents</code> operation.</p>"
|
||||
},
|
||||
"DescribeReplicationGroupsMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -2154,10 +2166,10 @@
|
|||
},
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</p>"
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>DescribeReplicationGroups</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>DescribeReplicationGroups</code> operation.</p>"
|
||||
},
|
||||
"DescribeReservedCacheNodesMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -2172,7 +2184,7 @@
|
|||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.</p> <p>Valid node types are as follows:</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized: <code>cache.c1.xlarge</code> </p> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Notes:</b> </p> <ul> <li> <p>All t2 instances are created in an Amazon Virtual Private Cloud (VPC).</p> </li> <li> <p>Redis backup/restore is not supported for t2 instances.</p> </li> <li> <p>Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.</p> </li> </ul> <p>For a complete listing of cache node types and specifications, see <a href=\"http://aws.amazon.com/elasticache/details\">Amazon ElastiCache Product Features and Details</a> and <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#CacheParameterGroups.Memcached.NodeSpecific\">Cache Node Type-Specific Parameters for Memcached</a> or <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#CacheParameterGroups.Redis.NodeSpecific\">Cache Node Type-Specific Parameters for Redis</a>.</p>"
|
||||
"documentation":"<p>The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.</p> <p>Valid node types are as follows:</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code>, <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized: <code>cache.c1.xlarge</code> </p> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Notes:</b> </p> <ul> <li> <p>All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).</p> </li> <li> <p>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.</p> </li> <li> <p>Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.</p> </li> </ul> <p>For a complete listing of node types and specifications, see <a href=\"http://aws.amazon.com/elasticache/details\">Amazon ElastiCache Product Features and Details</a> and either <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#ParameterGroups.Memcached.NodeSpecific\">Cache Node Type-Specific Parameters for Memcached</a> or <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#ParameterGroups.Redis.NodeSpecific\">Cache Node Type-Specific Parameters for Redis</a>.</p>"
|
||||
},
|
||||
"Duration":{
|
||||
"shape":"String",
|
||||
|
|
@ -2192,10 +2204,10 @@
|
|||
},
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</p>"
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>DescribeReservedCacheNodes</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>DescribeReservedCacheNodes</code> operation.</p>"
|
||||
},
|
||||
"DescribeReservedCacheNodesOfferingsMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -2206,7 +2218,7 @@
|
|||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.</p> <p>Valid node types are as follows:</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized: <code>cache.c1.xlarge</code> </p> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Notes:</b> </p> <ul> <li> <p>All t2 instances are created in an Amazon Virtual Private Cloud (VPC).</p> </li> <li> <p>Redis backup/restore is not supported for t2 instances.</p> </li> <li> <p>Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.</p> </li> </ul> <p>For a complete listing of cache node types and specifications, see <a href=\"http://aws.amazon.com/elasticache/details\">Amazon ElastiCache Product Features and Details</a> and <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#CacheParameterGroups.Memcached.NodeSpecific\">Cache Node Type-Specific Parameters for Memcached</a> or <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#CacheParameterGroups.Redis.NodeSpecific\">Cache Node Type-Specific Parameters for Redis</a>.</p>"
|
||||
"documentation":"<p>The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.</p> <p>Valid node types are as follows:</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code>, <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized: <code>cache.c1.xlarge</code> </p> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Notes:</b> </p> <ul> <li> <p>All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).</p> </li> <li> <p>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.</p> </li> <li> <p>Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.</p> </li> </ul> <p>For a complete listing of node types and specifications, see <a href=\"http://aws.amazon.com/elasticache/details\">Amazon ElastiCache Product Features and Details</a> and either <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#ParameterGroups.Memcached.NodeSpecific\">Cache Node Type-Specific Parameters for Memcached</a> or <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#ParameterGroups.Redis.NodeSpecific\">Cache Node Type-Specific Parameters for Redis</a>.</p>"
|
||||
},
|
||||
"Duration":{
|
||||
"shape":"String",
|
||||
|
|
@ -2226,35 +2238,39 @@
|
|||
},
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</p>"
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>DescribeReservedCacheNodesOfferings</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>DescribeReservedCacheNodesOfferings</code> operation.</p>"
|
||||
},
|
||||
"DescribeSnapshotsListMessage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</p>"
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
|
||||
},
|
||||
"Snapshots":{
|
||||
"shape":"SnapshotList",
|
||||
"documentation":"<p>A list of snapshots. Each item in the list contains detailed information about one snapshot.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a <i>DescribeSnapshots</i> action.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>DescribeSnapshots</code> operation.</p>"
|
||||
},
|
||||
"DescribeSnapshotsMessage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.</p>"
|
||||
},
|
||||
"CacheClusterId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.</p>"
|
||||
"documentation":"<p>A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster are described.</p>"
|
||||
},
|
||||
"SnapshotName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.</p>"
|
||||
"documentation":"<p>A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.</p>"
|
||||
},
|
||||
"SnapshotSource":{
|
||||
"shape":"String",
|
||||
|
|
@ -2262,14 +2278,18 @@
|
|||
},
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>.</p>"
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
|
||||
},
|
||||
"MaxRecords":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a marker is included in the response so that the remaining results can be retrieved.</p> <p>Default: 50</p> <p>Constraints: minimum 20; maximum 50.</p>"
|
||||
},
|
||||
"ShowNodeGroupConfig":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>A boolean value which if true, the node group (shard) configuration is included in the snapshot description.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>DescribeSnapshotsMessage</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>DescribeSnapshotsMessage</code> operation.</p>"
|
||||
},
|
||||
"Double":{"type":"double"},
|
||||
"EC2SecurityGroup":{
|
||||
|
|
@ -2316,7 +2336,7 @@
|
|||
"members":{
|
||||
"CacheParameterGroupFamily":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Specifies the name of the cache parameter group family to which the engine default parameters apply.</p>"
|
||||
"documentation":"<p>Specifies the name of the cache parameter group family to which the engine default parameters apply.</p> <p>Valid values are: <code>memcached1.4</code> | <code>redis2.6</code> | <code>redis2.8</code> | <code>redis3.2</code> </p>"
|
||||
},
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
|
|
@ -2331,7 +2351,7 @@
|
|||
"documentation":"<p>A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a <i>DescribeEngineDefaultParameters</i> action.</p>",
|
||||
"documentation":"<p>Represents the output of a <code>DescribeEngineDefaultParameters</code> operation.</p>",
|
||||
"wrapper":true
|
||||
},
|
||||
"Event":{
|
||||
|
|
@ -2375,7 +2395,7 @@
|
|||
"documentation":"<p>A list of events. Each element in the list contains detailed information about one event.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a <i>DescribeEvents</i> action.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>DescribeEvents</code> operation.</p>"
|
||||
},
|
||||
"InsufficientCacheClusterCapacityFault":{
|
||||
"type":"structure",
|
||||
|
|
@ -2407,7 +2427,7 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The requested cache cluster is not in the <i>available</i> state.</p>",
|
||||
"documentation":"<p>The requested cache cluster is not in the <code>available</code> state.</p>",
|
||||
"error":{
|
||||
"code":"InvalidCacheClusterState",
|
||||
"httpStatusCode":400,
|
||||
|
|
@ -2419,7 +2439,7 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The current state of the cache parameter group does not allow the requested action to occur.</p>",
|
||||
"documentation":"<p>The current state of the cache parameter group does not allow the requested operation to occur.</p>",
|
||||
"error":{
|
||||
"code":"InvalidCacheParameterGroupState",
|
||||
"httpStatusCode":400,
|
||||
|
|
@ -2475,7 +2495,7 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The requested replication group is not in the <i>available</i> state.</p>",
|
||||
"documentation":"<p>The requested replication group is not in the <code>available</code> state.</p>",
|
||||
"error":{
|
||||
"code":"InvalidReplicationGroupState",
|
||||
"httpStatusCode":400,
|
||||
|
|
@ -2487,7 +2507,7 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The current state of the snapshot does not allow the requested action to occur.</p>",
|
||||
"documentation":"<p>The current state of the snapshot does not allow the requested operation to occur.</p>",
|
||||
"error":{
|
||||
"code":"InvalidSnapshotState",
|
||||
"httpStatusCode":400,
|
||||
|
|
@ -2528,14 +2548,14 @@
|
|||
"members":{
|
||||
"CacheClusterId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>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 to create a list of node types you can scale up to.</p> <important> <p>You must provide a value for either the <i>CacheClusterId</i> or the <i>ReplicationGroupId</i>.</p> </important>"
|
||||
"documentation":"<p>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.</p> <important> <p>You must provide a value for either the <code>CacheClusterId</code> or the <code>ReplicationGroupId</code>.</p> </important>"
|
||||
},
|
||||
"ReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>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.</p> <important> <p>You must provide a value for either the <i>CacheClusterId</i> or the <i>ReplicationGroupId</i>.</p> </important>"
|
||||
"documentation":"<p>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.</p> <important> <p>You must provide a value for either the <code>CacheClusterId</code> or the <code>ReplicationGroupId</code>.</p> </important>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The input parameters for the <i>ListAllowedNodeTypeModifications</i> action.</p>"
|
||||
"documentation":"<p>The input parameters for the <code>ListAllowedNodeTypeModifications</code> operation.</p>"
|
||||
},
|
||||
"ListTagsForResourceMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -2543,10 +2563,10 @@
|
|||
"members":{
|
||||
"ResourceName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example <code>arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster</code> or <code>arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot</code>.</p> <p>For more information on ARNs, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example <code>arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster</code> or <code>arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot</code>.</p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The input parameters for the <i>ListTagsForResource</i> action.</p>"
|
||||
"documentation":"<p>The input parameters for the <code>ListTagsForResource</code> operation.</p>"
|
||||
},
|
||||
"ModifyCacheClusterMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -2558,47 +2578,47 @@
|
|||
},
|
||||
"NumCacheNodes":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The number of cache nodes that the cache cluster should have. If the value for <code>NumCacheNodes</code> 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.</p> <p>If you are removing cache nodes, you must use the <code>CacheNodeIdsToRemove</code> parameter to provide the IDs of the specific cache nodes to remove.</p> <p>For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.</p> <note> <p>Adding or removing Memcached cache nodes can be applied immediately or as a pending action. See <code>ApplyImmediately</code>.</p> <p>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 <code>ModifyCacheCluster</code> request and set <i>NumCacheNodes</i> equal to the number of cache nodes currently in the cache cluster.</p> </note>"
|
||||
"documentation":"<p>The number of cache nodes that the cache cluster should have. If the value for <code>NumCacheNodes</code> 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.</p> <p>If you are removing cache nodes, you must use the <code>CacheNodeIdsToRemove</code> parameter to provide the IDs of the specific cache nodes to remove.</p> <p>For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.</p> <note> <p>Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see <code>ApplyImmediately</code>).</p> <p>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 <code>ModifyCacheCluster</code> request and set <code>NumCacheNodes</code> equal to the number of cache nodes currently in the cache cluster.</p> </note>"
|
||||
},
|
||||
"CacheNodeIdsToRemove":{
|
||||
"shape":"CacheNodeIdsList",
|
||||
"documentation":"<p>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 <i>NumCacheNodes</i> 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 <i>NumCacheNodes</i> in the request.</p> <p>For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this <code>ModifyCacheCluser</code> call is 5, you must list 2 (7 - 5) cache node IDs to remove.</p>"
|
||||
"documentation":"<p>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 <code>NumCacheNodes</code> 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 <code>NumCacheNodes</code> in the request.</p> <p>For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this <code>ModifyCacheCluser</code> call is 5, you must list 2 (7 - 5) cache node IDs to remove.</p>"
|
||||
},
|
||||
"AZMode":{
|
||||
"shape":"AZMode",
|
||||
"documentation":"<p>Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.</p> <p>Valid values: <code>single-az</code> | <code>cross-az</code>.</p> <p>This option is only supported for Memcached cache clusters.</p> <note> <p>You cannot specify <code>single-az</code> if the Memcached cache cluster already has cache nodes in different Availability Zones. If <code>cross-az</code> is specified, existing Memcached nodes remain in their current Availability Zone.</p> <p>Only newly created nodes will be located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the <b>Availability Zone Considerations</b> section of <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheNode.Memcached.html\">Cache Node Considerations for Memcached</a>.</p> </note>"
|
||||
"documentation":"<p>Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.</p> <p>Valid values: <code>single-az</code> | <code>cross-az</code>.</p> <p>This option is only supported for Memcached cache clusters.</p> <note> <p>You cannot specify <code>single-az</code> if the Memcached cache cluster already has cache nodes in different Availability Zones. If <code>cross-az</code> is specified, existing Memcached nodes remain in their current Availability Zone.</p> <p>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 <b>Availability Zone Considerations</b> section of <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheNode.Memcached.html\">Cache Node Considerations for Memcached</a>.</p> </note>"
|
||||
},
|
||||
"NewAvailabilityZones":{
|
||||
"shape":"PreferredAvailabilityZoneList",
|
||||
"documentation":"<p>The list of Availability Zones where the new Memcached cache nodes will be created.</p> <p>This parameter is only valid when <i>NumCacheNodes</i> 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.</p> <p>This option is only supported on Memcached clusters.</p> <p>Scenarios:</p> <ul> <li> <p> <b>Scenario 1:</b> You have 3 active nodes and wish to add 2 nodes. Specify <code>NumCacheNodes=5</code> (3 + 2) and optionally specify two Availability Zones for the two new nodes.</p> </li> <li> <p> <b>Scenario 2:</b> You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify <code>NumCacheNodes=6</code> ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.</p> </li> <li> <p> <b>Scenario 3:</b> You want to cancel all pending actions. Specify <code>NumCacheNodes=3</code> to cancel all pending actions.</p> </li> </ul> <p>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 <code>NumCacheNodes</code> to the number of current nodes.</p> <p>If <code>cross-az</code> 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 <b>Availability Zone Considerations</b> section of <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheNode.Memcached.html\">Cache Node Considerations for Memcached</a>.</p> <p> <b>Impact of new add/remove requests upon pending requests</b> </p> <ul> <li> <p>Scenario-1</p> <ul> <li> <p>Pending Action: Delete</p> </li> <li> <p>New Request: Delete</p> </li> <li> <p>Result: The new delete, pending or immediate, replaces the pending delete.</p> </li> </ul> </li> <li> <p>Scenario-2</p> <ul> <li> <p>Pending Action: Delete</p> </li> <li> <p>New Request: Create</p> </li> <li> <p>Result: The new create, pending or immediate, replaces the pending delete.</p> </li> </ul> </li> <li> <p>Scenario-3</p> <ul> <li> <p>Pending Action: Create</p> </li> <li> <p>New Request: Delete</p> </li> <li> <p>Result: The new delete, pending or immediate, replaces the pending create.</p> </li> </ul> </li> <li> <p>Scenario-4</p> <ul> <li> <p>Pending Action: Create</p> </li> <li> <p>New Request: Create</p> </li> <li> <p>Result: The new create is added to the pending create.</p> <important> <p> <b>Important:</b> If the new create request is <b>Apply Immediately - Yes</b>, all creates are performed immediately. If the new create request is <b>Apply Immediately - No</b>, all creates are pending.</p> </important> </li> </ul> </li> </ul> <p>Example:</p> <p> <code>NewAvailabilityZones.member.1=us-west-2a&amp;NewAvailabilityZones.member.2=us-west-2b&amp;NewAvailabilityZones.member.3=us-west-2c</code> </p>"
|
||||
"documentation":"<p>The list of Availability Zones where the new Memcached cache nodes are created.</p> <p>This parameter is only valid when <code>NumCacheNodes</code> 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.</p> <p>This option is only supported on Memcached clusters.</p> <p>Scenarios:</p> <ul> <li> <p> <b>Scenario 1:</b> You have 3 active nodes and wish to add 2 nodes. Specify <code>NumCacheNodes=5</code> (3 + 2) and optionally specify two Availability Zones for the two new nodes.</p> </li> <li> <p> <b>Scenario 2:</b> You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify <code>NumCacheNodes=6</code> ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.</p> </li> <li> <p> <b>Scenario 3:</b> You want to cancel all pending operations. Specify <code>NumCacheNodes=3</code> to cancel all pending operations.</p> </li> </ul> <p>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 <code>NumCacheNodes</code> to the number of current nodes.</p> <p>If <code>cross-az</code> 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 <b>Availability Zone Considerations</b> section of <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheNode.Memcached.html\">Cache Node Considerations for Memcached</a>.</p> <p> <b>Impact of new add/remove requests upon pending requests</b> </p> <ul> <li> <p>Scenario-1</p> <ul> <li> <p>Pending Action: Delete</p> </li> <li> <p>New Request: Delete</p> </li> <li> <p>Result: The new delete, pending or immediate, replaces the pending delete.</p> </li> </ul> </li> <li> <p>Scenario-2</p> <ul> <li> <p>Pending Action: Delete</p> </li> <li> <p>New Request: Create</p> </li> <li> <p>Result: The new create, pending or immediate, replaces the pending delete.</p> </li> </ul> </li> <li> <p>Scenario-3</p> <ul> <li> <p>Pending Action: Create</p> </li> <li> <p>New Request: Delete</p> </li> <li> <p>Result: The new delete, pending or immediate, replaces the pending create.</p> </li> </ul> </li> <li> <p>Scenario-4</p> <ul> <li> <p>Pending Action: Create</p> </li> <li> <p>New Request: Create</p> </li> <li> <p>Result: The new create is added to the pending create.</p> <important> <p> <b>Important:</b> If the new create request is <b>Apply Immediately - Yes</b>, all creates are performed immediately. If the new create request is <b>Apply Immediately - No</b>, all creates are pending.</p> </important> </li> </ul> </li> </ul>"
|
||||
},
|
||||
"CacheSecurityGroupNames":{
|
||||
"shape":"CacheSecurityGroupNameList",
|
||||
"documentation":"<p>A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.</p> <p>This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).</p> <p>Constraints: Must contain no more than 255 alphanumeric characters. Must not be \"Default\".</p>"
|
||||
"documentation":"<p>A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.</p> <p>You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).</p> <p>Constraints: Must contain no more than 255 alphanumeric characters. Must not be \"Default\".</p>"
|
||||
},
|
||||
"SecurityGroupIds":{
|
||||
"shape":"SecurityGroupIdsList",
|
||||
"documentation":"<p>Specifies the VPC Security Groups associated with the cache cluster.</p> <p>This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).</p>"
|
||||
"documentation":"<p>Specifies the VPC Security Groups associated with the cache cluster.</p> <p>This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).</p>"
|
||||
},
|
||||
"PreferredMaintenanceWindow":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>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 <code>ddd</code> are:</p> <ul> <li> <p> <code>sun</code> </p> </li> <li> <p> <code>mon</code> </p> </li> <li> <p> <code>tue</code> </p> </li> <li> <p> <code>wed</code> </p> </li> <li> <p> <code>thu</code> </p> </li> <li> <p> <code>fri</code> </p> </li> <li> <p> <code>sat</code> </p> </li> </ul> <p>Example: <code>sun:05:00-sun:09:00</code> </p>"
|
||||
"documentation":"<p>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.</p> <p>Valid values for <code>ddd</code> are:</p> <ul> <li> <p> <code>sun</code> </p> </li> <li> <p> <code>mon</code> </p> </li> <li> <p> <code>tue</code> </p> </li> <li> <p> <code>wed</code> </p> </li> <li> <p> <code>thu</code> </p> </li> <li> <p> <code>fri</code> </p> </li> <li> <p> <code>sat</code> </p> </li> </ul> <p>Example: <code>sun:23:00-mon:01:30</code> </p>"
|
||||
},
|
||||
"NotificationTopicArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.</p> <note> <p>The Amazon SNS topic owner must be same as the cache cluster owner.</p> </note>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.</p> <note> <p>The Amazon SNS topic owner must be same as the cache cluster owner.</p> </note>"
|
||||
},
|
||||
"CacheParameterGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>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 <i>ApplyImmediately</i> parameter is specified as <i>true</i> for this request.</p>"
|
||||
"documentation":"<p>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 <code>ApplyImmediately</code> parameter is specified as <code>true</code> for this request.</p>"
|
||||
},
|
||||
"NotificationTopicStatus":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The status of the Amazon SNS notification topic. Notifications are sent only if the status is <i>active</i>.</p> <p>Valid values: <code>active</code> | <code>inactive</code> </p>"
|
||||
"documentation":"<p>The status of the Amazon SNS notification topic. Notifications are sent only if the status is <code>active</code>.</p> <p>Valid values: <code>active</code> | <code>inactive</code> </p>"
|
||||
},
|
||||
"ApplyImmediately":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>If <code>true</code>, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the <i>PreferredMaintenanceWindow</i> setting for the cache cluster.</p> <p>If <code>false</code>, then changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.</p> <important> <p>If you perform a <code>ModifyCacheCluster</code> before a pending modification is applied, the pending modification is replaced by the newer modification.</p> </important> <p>Valid values: <code>true</code> | <code>false</code> </p> <p>Default: <code>false</code> </p>"
|
||||
"documentation":"<p>If <code>true</code>, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the cache cluster.</p> <p>If <code>false</code>, changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.</p> <important> <p>If you perform a <code>ModifyCacheCluster</code> before a pending modification is applied, the pending modification is replaced by the newer modification.</p> </important> <p>Valid values: <code>true</code> | <code>false</code> </p> <p>Default: <code>false</code> </p>"
|
||||
},
|
||||
"EngineVersion":{
|
||||
"shape":"String",
|
||||
|
|
@ -2610,18 +2630,18 @@
|
|||
},
|
||||
"SnapshotRetentionLimit":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set <i>SnapshotRetentionLimit</i> to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.</p> <note> <p>If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</p> </note>"
|
||||
"documentation":"<p>The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. For example, if you set <code>SnapshotRetentionLimit</code> to 5, a snapshot that was taken today is retained for 5 days before being deleted.</p> <note> <p>If the value of <code>SnapshotRetentionLimit</code> is set to zero (0), backups are turned off.</p> </note>"
|
||||
},
|
||||
"SnapshotWindow":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. </p>"
|
||||
"documentation":"<p>The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cache cluster. </p>"
|
||||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A valid cache node type that you want to scale this cache cluster to. The value of this parameter must be one of the <i>ScaleUpModifications</i> values returned by the <code>ListAllowedCacheNodeTypeModification</code> action.</p>"
|
||||
"documentation":"<p>A valid cache node type that you want to scale this cache cluster up to.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>ModifyCacheCluster</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>ModifyCacheCluster</code> operation.</p>"
|
||||
},
|
||||
"ModifyCacheClusterResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -2645,7 +2665,7 @@
|
|||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>ModifyCacheParameterGroup</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>ModifyCacheParameterGroup</code> operation.</p>"
|
||||
},
|
||||
"ModifyCacheSubnetGroupMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -2657,14 +2677,14 @@
|
|||
},
|
||||
"CacheSubnetGroupDescription":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A description for the cache subnet group.</p>"
|
||||
"documentation":"<p>A description of the cache subnet group.</p>"
|
||||
},
|
||||
"SubnetIds":{
|
||||
"shape":"SubnetIdentifierList",
|
||||
"documentation":"<p>The EC2 subnet IDs for the cache subnet group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>ModifyCacheSubnetGroup</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>ModifyCacheSubnetGroup</code> operation.</p>"
|
||||
},
|
||||
"ModifyCacheSubnetGroupResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -2686,43 +2706,43 @@
|
|||
},
|
||||
"PrimaryClusterId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>If this parameter is specified, ElastiCache will promote the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group will be read replicas.</p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"SnapshottingClusterId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The cache cluster ID that will be used as the daily snapshot source for the replication group.</p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"AutomaticFailoverEnabled":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.</p> <p>Valid values: <code>true</code> | <code>false</code> </p> <note> <p>ElastiCache Multi-AZ replication groups are not supported on:</p> <ul> <li> <p>Redis versions earlier than 2.8.6.</p> </li> <li> <p>T1 and T2 cache node types.</p> </li> </ul> </note>"
|
||||
"documentation":"<p>Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.</p> <p>Valid values: <code>true</code> | <code>false</code> </p> <note> <p>ElastiCache Multi-AZ replication groups are not supported on:</p> <ul> <li> <p>Redis versions earlier than 2.8.6.</p> </li> <li> <p>Redis (cluster mode disabled):T1 and T2 cache node types.</p> <p>Redis (cluster mode enabled): T1 node types.</p> </li> </ul> </note>"
|
||||
},
|
||||
"CacheSecurityGroupNames":{
|
||||
"shape":"CacheSecurityGroupNameList",
|
||||
"documentation":"<p>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.</p> <p>This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (VPC).</p> <p>Constraints: Must contain no more than 255 alphanumeric characters. Must not be \"Default\".</p>"
|
||||
"documentation":"<p>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.</p> <p>This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).</p> <p>Constraints: Must contain no more than 255 alphanumeric characters. Must not be <code>Default</code>.</p>"
|
||||
},
|
||||
"SecurityGroupIds":{
|
||||
"shape":"SecurityGroupIdsList",
|
||||
"documentation":"<p>Specifies the VPC Security Groups associated with the cache clusters in the replication group.</p> <p>This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).</p>"
|
||||
"documentation":"<p>Specifies the VPC Security Groups associated with the cache clusters in the replication group.</p> <p>This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (Amazon VPC).</p>"
|
||||
},
|
||||
"PreferredMaintenanceWindow":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>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 <code>ddd</code> are:</p> <ul> <li> <p> <code>sun</code> </p> </li> <li> <p> <code>mon</code> </p> </li> <li> <p> <code>tue</code> </p> </li> <li> <p> <code>wed</code> </p> </li> <li> <p> <code>thu</code> </p> </li> <li> <p> <code>fri</code> </p> </li> <li> <p> <code>sat</code> </p> </li> </ul> <p>Example: <code>sun:05:00-sun:09:00</code> </p>"
|
||||
"documentation":"<p>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.</p> <p>Valid values for <code>ddd</code> are:</p> <ul> <li> <p> <code>sun</code> </p> </li> <li> <p> <code>mon</code> </p> </li> <li> <p> <code>tue</code> </p> </li> <li> <p> <code>wed</code> </p> </li> <li> <p> <code>thu</code> </p> </li> <li> <p> <code>fri</code> </p> </li> <li> <p> <code>sat</code> </p> </li> </ul> <p>Example: <code>sun:23:00-mon:01:30</code> </p>"
|
||||
},
|
||||
"NotificationTopicArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.</p> <note> <p>The Amazon SNS topic owner must be same as the replication group owner. </p> </note>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.</p> <note> <p>The Amazon SNS topic owner must be same as the replication group owner. </p> </note>"
|
||||
},
|
||||
"CacheParameterGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>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 <i>ApplyImmediately</i> parameter is specified as <i>true</i> for this request.</p>"
|
||||
"documentation":"<p>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 <code>ApplyImmediately</code> parameter is specified as <code>true</code> for this request.</p>"
|
||||
},
|
||||
"NotificationTopicStatus":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is <i>active</i>.</p> <p>Valid values: <code>active</code> | <code>inactive</code> </p>"
|
||||
"documentation":"<p>The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is <code>active</code>.</p> <p>Valid values: <code>active</code> | <code>inactive</code> </p>"
|
||||
},
|
||||
"ApplyImmediately":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>If <code>true</code>, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the <i>PreferredMaintenanceWindow</i> setting for the replication group.</p> <p>If <code>false</code>, then changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.</p> <p>Valid values: <code>true</code> | <code>false</code> </p> <p>Default: <code>false</code> </p>"
|
||||
"documentation":"<p>If <code>true</code>, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the replication group.</p> <p>If <code>false</code>, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.</p> <p>Valid values: <code>true</code> | <code>false</code> </p> <p>Default: <code>false</code> </p>"
|
||||
},
|
||||
"EngineVersion":{
|
||||
"shape":"String",
|
||||
|
|
@ -2734,18 +2754,18 @@
|
|||
},
|
||||
"SnapshotRetentionLimit":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The number of days for which ElastiCache will retain automatic node group snapshots before deleting them. For example, if you set <i>SnapshotRetentionLimit</i> to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.</p> <p> <b>Important</b> If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</p>"
|
||||
"documentation":"<p>The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them. For example, if you set <code>SnapshotRetentionLimit</code> to 5, a snapshot that was taken today is retained for 5 days before being deleted.</p> <p> <b>Important</b> If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</p>"
|
||||
},
|
||||
"SnapshotWindow":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the node group specified by <i>SnapshottingClusterId</i>.</p> <p>Example: <code>05:00-09:00</code> </p> <p>If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.</p>"
|
||||
"documentation":"<p>The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by <code>SnapshottingClusterId</code>.</p> <p>Example: <code>05:00-09:00</code> </p> <p>If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.</p>"
|
||||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A valid cache node type that you want to scale this replication group to. The value of this parameter must be one of the <i>ScaleUpModifications</i> values returned by the <code>ListAllowedCacheNodeTypeModification</code> action.</p>"
|
||||
"documentation":"<p>A valid cache node type that you want to scale this replication group to.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>ModifyReplicationGroups</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>ModifyReplicationGroups</code> operation.</p>"
|
||||
},
|
||||
"ModifyReplicationGroupResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -2758,19 +2778,55 @@
|
|||
"members":{
|
||||
"NodeGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.</p>"
|
||||
"documentation":"<p>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. </p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The current state of this replication group - <i>creating</i>, <i>available</i>, etc.</p>"
|
||||
"documentation":"<p>The current state of this replication group - <code>creating</code>, <code>available</code>, etc.</p>"
|
||||
},
|
||||
"PrimaryEndpoint":{
|
||||
"shape":"Endpoint",
|
||||
"documentation":"<p>The endpoint of the primary node in this node group (shard).</p>"
|
||||
},
|
||||
"Slots":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The keyspace for this node group (shard).</p>"
|
||||
},
|
||||
"PrimaryEndpoint":{"shape":"Endpoint"},
|
||||
"NodeGroupMembers":{
|
||||
"shape":"NodeGroupMemberList",
|
||||
"documentation":"<p>A list containing information about individual nodes within the node group.</p>"
|
||||
"documentation":"<p>A list containing information about individual nodes within the node group (shard).</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents a collection of cache nodes in a replication group.</p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"NodeGroupConfiguration":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Slots":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>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 <code>startkey-endkey</code>.</p> <p>Example: <code>\"0-3999\"</code> </p>"
|
||||
},
|
||||
"ReplicaCount":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The number of read replica nodes in this node group (shard).</p>"
|
||||
},
|
||||
"PrimaryAvailabilityZone":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Availability Zone where the primary node of this node group (shard) is launched.</p>"
|
||||
},
|
||||
"ReplicaAvailabilityZones":{
|
||||
"shape":"AvailabilityZonesList",
|
||||
"documentation":"<p>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 <code>ReplicaCount</code> or <code>ReplicasPerNodeGroup</code> if not specified.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>node group (shard) configuration options. Each node group (shard) configuration has the following: <code>Slots</code>, <code>PrimaryAvailabilityZone</code>, <code>ReplicaAvailabilityZones</code>, <code>ReplicaCount</code>.</p>"
|
||||
},
|
||||
"NodeGroupConfigurationList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"NodeGroupConfiguration",
|
||||
"locationName":"NodeGroupConfiguration"
|
||||
}
|
||||
},
|
||||
"NodeGroupList":{
|
||||
"type":"list",
|
||||
|
|
@ -2797,10 +2853,10 @@
|
|||
},
|
||||
"CurrentRole":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The role that is currently assigned to the node - <i>primary</i> or <i>replica</i>.</p>"
|
||||
"documentation":"<p>The role that is currently assigned to the node - <code>primary</code> or <code>replica</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents a single node within a node group.</p>"
|
||||
"documentation":"<p>Represents a single node within a node group (shard).</p>"
|
||||
},
|
||||
"NodeGroupMemberList":{
|
||||
"type":"list",
|
||||
|
|
@ -2809,6 +2865,18 @@
|
|||
"locationName":"NodeGroupMember"
|
||||
}
|
||||
},
|
||||
"NodeGroupsPerReplicationGroupQuotaExceededFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The request cannot be processed because it would exceed the maximum of 15 node groups (shards) in a single replication group.</p>",
|
||||
"error":{
|
||||
"code":"NodeGroupsPerReplicationGroupQuotaExceeded",
|
||||
"httpStatusCode":400,
|
||||
"senderFault":true
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"NodeQuotaForClusterExceededFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2836,10 +2904,22 @@
|
|||
"NodeSnapshot":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CacheClusterId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A unique identifier for the source cache cluster.</p>"
|
||||
},
|
||||
"NodeGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A unique identifier for the source node group (shard).</p>"
|
||||
},
|
||||
"CacheNodeId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The cache node identifier for the node in the source cache cluster.</p>"
|
||||
},
|
||||
"NodeGroupConfiguration":{
|
||||
"shape":"NodeGroupConfiguration",
|
||||
"documentation":"<p>The configuration for the source node group (shard).</p>"
|
||||
},
|
||||
"CacheSize":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The size of the cache on the source cache node.</p>"
|
||||
|
|
@ -2918,7 +2998,7 @@
|
|||
},
|
||||
"ChangeType":{
|
||||
"shape":"ChangeType",
|
||||
"documentation":"<p>ChangeType indicates whether a change to the parameter will be 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 <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Clusters.Rebooting.html\">Rebooting a Cluster</a>.</p>"
|
||||
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/Clusters.Rebooting.html\">Rebooting a Cluster</a>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes an individual setting that controls some aspect of ElastiCache behavior.</p>"
|
||||
|
|
@ -2971,14 +3051,14 @@
|
|||
},
|
||||
"EngineVersion":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The new cache engine version that the cache cluster will run.</p>"
|
||||
"documentation":"<p>The new cache engine version that the cache cluster runs.</p>"
|
||||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The cache node type that this cache cluster or replication group will be scaled to.</p>"
|
||||
"documentation":"<p>The cache node type that this cache cluster or replication group is scaled to.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.</p>"
|
||||
"documentation":"<p>A group of settings that are applied to the cache cluster in the future, or that are currently being applied.</p>"
|
||||
},
|
||||
"PreferredAvailabilityZoneList":{
|
||||
"type":"list",
|
||||
|
|
@ -3004,7 +3084,7 @@
|
|||
"documentation":"<p>The number of cache node instances to reserve.</p> <p>Default: <code>1</code> </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>PurchaseReservedCacheNodesOffering</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>PurchaseReservedCacheNodesOffering</code> operation.</p>"
|
||||
},
|
||||
"PurchaseReservedCacheNodesOfferingResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -3028,7 +3108,7 @@
|
|||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>RebootCacheCluster</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>RebootCacheCluster</code> operation.</p>"
|
||||
},
|
||||
"RebootCacheClusterResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -3067,14 +3147,14 @@
|
|||
"members":{
|
||||
"ResourceName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource from which you want the tags removed, for example <code>arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster</code> or <code>arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot</code>.</p> <p>For more information on ARNs, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource from which you want the tags removed, for example <code>arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster</code> or <code>arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot</code>.</p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
|
||||
},
|
||||
"TagKeys":{
|
||||
"shape":"KeyList",
|
||||
"documentation":"<p>A list of <code>TagKeys</code> identifying the tags you want removed from the named resource. For example, <code>TagKeys.member.1=Region</code> removes the cost allocation tag with the key name <code>Region</code> from the resource named by the <i>ResourceName</i> parameter.</p>"
|
||||
"documentation":"<p>A list of <code>TagKeys</code> identifying the tags you want removed from the named resource.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>RemoveTagsFromResource</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>RemoveTagsFromResource</code> operation.</p>"
|
||||
},
|
||||
"ReplicationGroup":{
|
||||
"type":"structure",
|
||||
|
|
@ -3089,7 +3169,7 @@
|
|||
},
|
||||
"Status":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The current state of this replication group - <i>creating</i>, <i>available</i>, etc.</p>"
|
||||
"documentation":"<p>The current state of this replication group - <code>creating</code>, <code>available</code>, etc.</p>"
|
||||
},
|
||||
"PendingModifiedValues":{
|
||||
"shape":"ReplicationGroupPendingModifiedValues",
|
||||
|
|
@ -3109,10 +3189,22 @@
|
|||
},
|
||||
"AutomaticFailover":{
|
||||
"shape":"AutomaticFailoverStatus",
|
||||
"documentation":"<p>Indicates the status of Multi-AZ for this replication group.</p> <note> <p>ElastiCache Multi-AZ replication groups are not supported on:</p> <ul> <li> <p>Redis versions earlier than 2.8.6.</p> </li> <li> <p>T1 and T2 cache node types.</p> </li> </ul> </note>"
|
||||
"documentation":"<p>Indicates the status of Multi-AZ for this replication group.</p> <note> <p>ElastiCache Multi-AZ replication groups are not supported on:</p> <ul> <li> <p>Redis versions earlier than 2.8.6.</p> </li> <li> <p>Redis (cluster mode disabled):T1 and T2 cache node types.</p> <p>Redis (cluster mode enabled): T1 node types.</p> </li> </ul> </note>"
|
||||
},
|
||||
"ConfigurationEndpoint":{
|
||||
"shape":"Endpoint",
|
||||
"documentation":"<p>The configuration endpoint for this replicaiton group. Use the configuration endpoint to connect to this replication group.</p>"
|
||||
},
|
||||
"SnapshotRetentionLimit":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. For example, if you set <code>SnapshotRetentionLimit</code> to 5, a snapshot that was taken today is retained for 5 days before being deleted.</p> <important> <p> If the value of <code>SnapshotRetentionLimit</code> is set to zero (0), backups are turned off.</p> </important>"
|
||||
},
|
||||
"SnapshotWindow":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).</p> <p>Example: <code>05:00-09:00</code> </p> <p>If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.</p> <p> <b>Note:</b> This parameter is only valid if the <code>Engine</code> parameter is <code>redis</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains all of the attributes of a specific replication group.</p>",
|
||||
"documentation":"<p>Contains all of the attributes of a specific Redis replication group.</p>",
|
||||
"wrapper":true
|
||||
},
|
||||
"ReplicationGroupAlreadyExistsFault":{
|
||||
|
|
@ -3146,7 +3238,7 @@
|
|||
"documentation":"<p>A list of replication groups. Each item in the list contains detailed information about one replication group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a <i>DescribeReplicationGroups</i> action.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>DescribeReplicationGroups</code> operation.</p>"
|
||||
},
|
||||
"ReplicationGroupNotFoundFault":{
|
||||
"type":"structure",
|
||||
|
|
@ -3165,14 +3257,14 @@
|
|||
"members":{
|
||||
"PrimaryClusterId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The primary cluster ID which will be applied immediately (if <code>--apply-immediately</code> was specified), or during the next maintenance window.</p>"
|
||||
"documentation":"<p>The primary cluster ID that is applied immediately (if <code>--apply-immediately</code> was specified), or during the next maintenance window.</p>"
|
||||
},
|
||||
"AutomaticFailoverStatus":{
|
||||
"shape":"PendingAutomaticFailoverStatus",
|
||||
"documentation":"<p>Indicates the status of Multi-AZ for this replication group.</p> <note> <p>ElastiCache Multi-AZ replication groups are not supported on:</p> <ul> <li> <p>Redis versions earlier than 2.8.6.</p> </li> <li> <p>T1 and T2 cache node types.</p> </li> </ul> </note>"
|
||||
"documentation":"<p>Indicates the status of Multi-AZ for this Redis replication group.</p> <note> <p>ElastiCache Multi-AZ replication groups are not supported on:</p> <ul> <li> <p>Redis versions earlier than 2.8.6.</p> </li> <li> <p>Redis (cluster mode disabled):T1 and T2 cache node types.</p> <p>Redis (cluster mode enabled): T1 node types.</p> </li> </ul> </note>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The settings to be applied to the replication group, either immediately or during the next maintenance window.</p>"
|
||||
"documentation":"<p>The settings to be applied to the Redis replication group, either immediately or during the next maintenance window.</p>"
|
||||
},
|
||||
"ReservedCacheNode":{
|
||||
"type":"structure",
|
||||
|
|
@ -3187,7 +3279,7 @@
|
|||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The cache node type for the reserved cache nodes.</p> <p>Valid node types are as follows:</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized: <code>cache.c1.xlarge</code> </p> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Notes:</b> </p> <ul> <li> <p>All t2 instances are created in an Amazon Virtual Private Cloud (VPC).</p> </li> <li> <p>Redis backup/restore is not supported for t2 instances.</p> </li> <li> <p>Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.</p> </li> </ul> <p>For a complete listing of cache node types and specifications, see <a href=\"http://aws.amazon.com/elasticache/details\">Amazon ElastiCache Product Features and Details</a> and <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#CacheParameterGroups.Memcached.NodeSpecific\">Cache Node Type-Specific Parameters for Memcached</a> or <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#CacheParameterGroups.Redis.NodeSpecific\">Cache Node Type-Specific Parameters for Redis</a>.</p>"
|
||||
"documentation":"<p>The cache node type for the reserved cache nodes.</p> <p>Valid node types are as follows:</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code>, <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized: <code>cache.c1.xlarge</code> </p> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Notes:</b> </p> <ul> <li> <p>All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).</p> </li> <li> <p>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.</p> </li> <li> <p>Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.</p> </li> </ul> <p>For a complete listing of node types and specifications, see <a href=\"http://aws.amazon.com/elasticache/details\">Amazon ElastiCache Product Features and Details</a> and either <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#ParameterGroups.Memcached.NodeSpecific\">Cache Node Type-Specific Parameters for Memcached</a> or <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#ParameterGroups.Redis.NodeSpecific\">Cache Node Type-Specific Parameters for Redis</a>.</p>"
|
||||
},
|
||||
"StartTime":{
|
||||
"shape":"TStamp",
|
||||
|
|
@ -3226,7 +3318,7 @@
|
|||
"documentation":"<p>The recurring price charged to run this reserved cache node.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a <i>PurchaseReservedCacheNodesOffering</i> action.</p>",
|
||||
"documentation":"<p>Represents the output of a <code>PurchaseReservedCacheNodesOffering</code> operation.</p>",
|
||||
"wrapper":true
|
||||
},
|
||||
"ReservedCacheNodeAlreadyExistsFault":{
|
||||
|
|
@ -3260,7 +3352,7 @@
|
|||
"documentation":"<p>A list of reserved cache nodes. Each element in the list contains detailed information about one node.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a <i>DescribeReservedCacheNodes</i> action.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>DescribeReservedCacheNodes</code> operation.</p>"
|
||||
},
|
||||
"ReservedCacheNodeNotFoundFault":{
|
||||
"type":"structure",
|
||||
|
|
@ -3295,7 +3387,7 @@
|
|||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The cache node type for the reserved cache node.</p> <p>Valid node types are as follows:</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized: <code>cache.c1.xlarge</code> </p> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Notes:</b> </p> <ul> <li> <p>All t2 instances are created in an Amazon Virtual Private Cloud (VPC).</p> </li> <li> <p>Redis backup/restore is not supported for t2 instances.</p> </li> <li> <p>Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.</p> </li> </ul> <p>For a complete listing of cache node types and specifications, see <a href=\"http://aws.amazon.com/elasticache/details\">Amazon ElastiCache Product Features and Details</a> and <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#CacheParameterGroups.Memcached.NodeSpecific\">Cache Node Type-Specific Parameters for Memcached</a> or <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#CacheParameterGroups.Redis.NodeSpecific\">Cache Node Type-Specific Parameters for Redis</a>.</p>"
|
||||
"documentation":"<p>The cache node type for the reserved cache node.</p> <p>Valid node types are as follows:</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code>, <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized: <code>cache.c1.xlarge</code> </p> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Notes:</b> </p> <ul> <li> <p>All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).</p> </li> <li> <p>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.</p> </li> <li> <p>Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.</p> </li> </ul> <p>For a complete listing of node types and specifications, see <a href=\"http://aws.amazon.com/elasticache/details\">Amazon ElastiCache Product Features and Details</a> and either <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#ParameterGroups.Memcached.NodeSpecific\">Cache Node Type-Specific Parameters for Memcached</a> or <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#ParameterGroups.Redis.NodeSpecific\">Cache Node Type-Specific Parameters for Redis</a>.</p>"
|
||||
},
|
||||
"Duration":{
|
||||
"shape":"Integer",
|
||||
|
|
@ -3344,7 +3436,7 @@
|
|||
"documentation":"<p>A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a <i>DescribeReservedCacheNodesOfferings</i> action.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>DescribeReservedCacheNodesOfferings</code> operation.</p>"
|
||||
},
|
||||
"ReservedCacheNodesOfferingNotFoundFault":{
|
||||
"type":"structure",
|
||||
|
|
@ -3368,14 +3460,14 @@
|
|||
},
|
||||
"ResetAllParameters":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>If <i>true</i>, all parameters in the cache parameter group will be reset to their default values. If <i>false</i>, only the parameters listed by <i>ParameterNameValues</i> are reset to their default values.</p> <p>Valid values: <code>true</code> | <code>false</code> </p>"
|
||||
"documentation":"<p>If <code>true</code>, all parameters in the cache parameter group are reset to their default values. If <code>false</code>, only the parameters listed by <code>ParameterNameValues</code> are reset to their default values.</p> <p>Valid values: <code>true</code> | <code>false</code> </p>"
|
||||
},
|
||||
"ParameterNameValues":{
|
||||
"shape":"ParameterNameValueList",
|
||||
"documentation":"<p>An array of parameter names to reset to their default values. If <i>ResetAllParameters</i> is <i>false</i>, you must specify the name of at least one parameter to reset.</p>"
|
||||
"documentation":"<p>An array of parameter names to reset to their default values. If <code>ResetAllParameters</code> is <code>true</code>, do not use <code>ParameterNameValues</code>. If <code>ResetAllParameters</code> is <code>false</code>, you must specify the name of at least one parameter to reset.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>ResetCacheParameterGroup</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>ResetCacheParameterGroup</code> operation.</p>"
|
||||
},
|
||||
"RevokeCacheSecurityGroupIngressMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -3398,7 +3490,7 @@
|
|||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>RevokeCacheSecurityGroupIngress</i> action.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>RevokeCacheSecurityGroupIngress</code> operation.</p>"
|
||||
},
|
||||
"RevokeCacheSecurityGroupIngressResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -3436,7 +3528,15 @@
|
|||
"members":{
|
||||
"SnapshotName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.</p>"
|
||||
"documentation":"<p>The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.</p>"
|
||||
},
|
||||
"ReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The unique identifier of the source replication group.</p>"
|
||||
},
|
||||
"ReplicationGroupDescription":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A description of the source replication group.</p>"
|
||||
},
|
||||
"CacheClusterId":{
|
||||
"shape":"String",
|
||||
|
|
@ -3452,11 +3552,11 @@
|
|||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the compute and memory capacity node type for the source cache cluster.</p> <p>Valid node types are as follows:</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized: <code>cache.c1.xlarge</code> </p> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Notes:</b> </p> <ul> <li> <p>All t2 instances are created in an Amazon Virtual Private Cloud (VPC).</p> </li> <li> <p>Redis backup/restore is not supported for t2 instances.</p> </li> <li> <p>Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.</p> </li> </ul> <p>For a complete listing of cache node types and specifications, see <a href=\"http://aws.amazon.com/elasticache/details\">Amazon ElastiCache Product Features and Details</a> and <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#CacheParameterGroups.Memcached.NodeSpecific\">Cache Node Type-Specific Parameters for Memcached</a> or <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#CacheParameterGroups.Redis.NodeSpecific\">Cache Node Type-Specific Parameters for Redis</a>.</p>"
|
||||
"documentation":"<p>The name of the compute and memory capacity node type for the source cache cluster.</p> <p>Valid node types are as follows:</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code>, <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code>, <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.t1.micro</code>, <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized: <code>cache.c1.xlarge</code> </p> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> <li> <p>Previous generation: <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Notes:</b> </p> <ul> <li> <p>All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).</p> </li> <li> <p>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.</p> </li> <li> <p>Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.</p> </li> </ul> <p>For a complete listing of node types and specifications, see <a href=\"http://aws.amazon.com/elasticache/details\">Amazon ElastiCache Product Features and Details</a> and either <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#ParameterGroups.Memcached.NodeSpecific\">Cache Node Type-Specific Parameters for Memcached</a> or <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#ParameterGroups.Redis.NodeSpecific\">Cache Node Type-Specific Parameters for Redis</a>.</p>"
|
||||
},
|
||||
"Engine":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the cache engine (<i>memcached</i> or <i>redis</i>) used by the source cache cluster.</p>"
|
||||
"documentation":"<p>The name of the cache engine (<code>memcached</code> or <code>redis</code>) used by the source cache cluster.</p>"
|
||||
},
|
||||
"EngineVersion":{
|
||||
"shape":"String",
|
||||
|
|
@ -3476,7 +3576,7 @@
|
|||
},
|
||||
"PreferredMaintenanceWindow":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>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 <code>ddd</code> are:</p> <ul> <li> <p> <code>sun</code> </p> </li> <li> <p> <code>mon</code> </p> </li> <li> <p> <code>tue</code> </p> </li> <li> <p> <code>wed</code> </p> </li> <li> <p> <code>thu</code> </p> </li> <li> <p> <code>fri</code> </p> </li> <li> <p> <code>sat</code> </p> </li> </ul> <p>Example: <code>sun:05:00-sun:09:00</code> </p>"
|
||||
"documentation":"<p>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.</p> <p>Valid values for <code>ddd</code> are:</p> <ul> <li> <p> <code>sun</code> </p> </li> <li> <p> <code>mon</code> </p> </li> <li> <p> <code>tue</code> </p> </li> <li> <p> <code>wed</code> </p> </li> <li> <p> <code>thu</code> </p> </li> <li> <p> <code>fri</code> </p> </li> <li> <p> <code>sat</code> </p> </li> </ul> <p>Example: <code>sun:23:00-mon:01:30</code> </p>"
|
||||
},
|
||||
"TopicArn":{
|
||||
"shape":"String",
|
||||
|
|
@ -3504,18 +3604,26 @@
|
|||
},
|
||||
"SnapshotRetentionLimit":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.</p> <p>For manual snapshots, this field reflects the <i>SnapshotRetentionLimit</i> 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 <i>DeleteSnapshot</i> action. </p> <p> <b>Important</b> If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</p>"
|
||||
"documentation":"<p>For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.</p> <p>For manual snapshots, this field reflects the <code>SnapshotRetentionLimit</code> 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 <code>DeleteSnapshot</code> operation. </p> <p> <b>Important</b> If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</p>"
|
||||
},
|
||||
"SnapshotWindow":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.</p>"
|
||||
},
|
||||
"NumNodeGroups":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"AutomaticFailover":{
|
||||
"shape":"AutomaticFailoverStatus",
|
||||
"documentation":"<p>Indicates the status of Multi-AZ for the source replication group.</p> <note> <p>ElastiCache Multi-AZ replication groups are not supported on:</p> <ul> <li> <p>Redis versions earlier than 2.8.6.</p> </li> <li> <p>Redis (cluster mode disabled):T1 and T2 cache node types.</p> <p>Redis (cluster mode enabled): T1 node types.</p> </li> </ul> </note>"
|
||||
},
|
||||
"NodeSnapshots":{
|
||||
"shape":"NodeSnapshotList",
|
||||
"documentation":"<p>A list of the cache nodes in the source cache cluster.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents a copy of an entire cache cluster as of the time when the snapshot was taken.</p>",
|
||||
"documentation":"<p>Represents a copy of an entire Redis cache cluster as of the time when the snapshot was taken.</p>",
|
||||
"wrapper":true
|
||||
},
|
||||
"SnapshotAlreadyExistsFault":{
|
||||
|
|
@ -3541,7 +3649,7 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>You attempted one of the following actions:</p> <ul> <li> <p>Creating a snapshot of a Redis cache cluster running on a <i>t1.micro</i> cache node.</p> </li> <li> <p>Creating a snapshot of a cache cluster that is running Memcached rather than Redis.</p> </li> </ul> <p>Neither of these are supported by ElastiCache.</p>",
|
||||
"documentation":"<p>You attempted one of the following operations:</p> <ul> <li> <p>Creating a snapshot of a Redis cache cluster running on a <code>cache.t1.micro</code> cache node.</p> </li> <li> <p>Creating a snapshot of a cache cluster that is running Memcached rather than Redis.</p> </li> </ul> <p>Neither of these are supported by ElastiCache.</p>",
|
||||
"error":{
|
||||
"code":"SnapshotFeatureNotSupportedFault",
|
||||
"httpStatusCode":400,
|
||||
|
|
@ -3586,7 +3694,8 @@
|
|||
"cache-cluster",
|
||||
"cache-parameter-group",
|
||||
"cache-security-group",
|
||||
"cache-subnet-group"
|
||||
"cache-subnet-group",
|
||||
"replication-group"
|
||||
]
|
||||
},
|
||||
"String":{"type":"string"},
|
||||
|
|
@ -3660,7 +3769,7 @@
|
|||
"documentation":"<p>A list of cost allocation tags as key-value pairs.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output from the <i>AddTagsToResource</i>, <i>ListTagsOnResource</i>, and <i>RemoveTagsFromResource</i> actions.</p>"
|
||||
"documentation":"<p>Represents the output from the <code>AddTagsToResource</code>, <code>ListTagsOnResource</code>, and <code>RemoveTagsFromResource</code> operations.</p>"
|
||||
},
|
||||
"TagNotFoundFault":{
|
||||
"type":"structure",
|
||||
|
|
@ -3687,5 +3796,5 @@
|
|||
"exception":true
|
||||
}
|
||||
},
|
||||
"documentation":"<fullname>Amazon ElastiCache</fullname> <p>Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.</p> <p>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.</p> <p>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.</p>"
|
||||
"documentation":"<fullname>Amazon ElastiCache</fullname> <p>Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.</p> <p>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.</p> <p>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.</p>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@
|
|||
"shape":"CheckDNSAvailabilityResultMessage",
|
||||
"resultWrapper":"CheckDNSAvailabilityResult"
|
||||
},
|
||||
"documentation":"<p> Checks if the specified CNAME is available. </p>"
|
||||
"documentation":"<p>Checks if the specified CNAME is available.</p>"
|
||||
},
|
||||
"ComposeEnvironments":{
|
||||
"name":"ComposeEnvironments",
|
||||
|
|
@ -102,7 +102,7 @@
|
|||
{"shape":"InsufficientPrivilegesException"},
|
||||
{"shape":"S3LocationNotInServiceRegionException"}
|
||||
],
|
||||
"documentation":"<p>Creates an application version for the specified application.</p> <note>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. </note>"
|
||||
"documentation":"<p>Creates an application version for the specified application.</p> <note> <p>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.</p> </note>"
|
||||
},
|
||||
"CreateConfigurationTemplate":{
|
||||
"name":"CreateConfigurationTemplate",
|
||||
|
|
@ -120,7 +120,7 @@
|
|||
{"shape":"TooManyBucketsException"},
|
||||
{"shape":"TooManyConfigurationTemplatesException"}
|
||||
],
|
||||
"documentation":"<p>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.</p> <p>Related Topics</p> <ul> <li> <a>DescribeConfigurationOptions</a> </li> <li> <a>DescribeConfigurationSettings</a> </li> <li> <a>ListAvailableSolutionStacks</a> </li> </ul>"
|
||||
"documentation":"<p>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.</p> <p>Related Topics</p> <ul> <li> <p> <a>DescribeConfigurationOptions</a> </p> </li> <li> <p> <a>DescribeConfigurationSettings</a> </p> </li> <li> <p> <a>ListAvailableSolutionStacks</a> </p> </li> </ul>"
|
||||
},
|
||||
"CreateEnvironment":{
|
||||
"name":"CreateEnvironment",
|
||||
|
|
@ -154,7 +154,7 @@
|
|||
{"shape":"S3SubscriptionRequiredException"},
|
||||
{"shape":"InsufficientPrivilegesException"}
|
||||
],
|
||||
"documentation":"<p> Creates the Amazon S3 storage location for the account. </p> <p> This location is used to store user log files. </p>"
|
||||
"documentation":"<p>Creates the Amazon S3 storage location for the account.</p> <p>This location is used to store user log files.</p>"
|
||||
},
|
||||
"DeleteApplication":{
|
||||
"name":"DeleteApplication",
|
||||
|
|
@ -166,7 +166,7 @@
|
|||
"errors":[
|
||||
{"shape":"OperationInProgressException"}
|
||||
],
|
||||
"documentation":"<p> Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket. </p> <note>You cannot delete an application that has a running environment. </note>"
|
||||
"documentation":"<p>Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.</p> <note> <p>You cannot delete an application that has a running environment.</p> </note>"
|
||||
},
|
||||
"DeleteApplicationVersion":{
|
||||
"name":"DeleteApplicationVersion",
|
||||
|
|
@ -181,7 +181,7 @@
|
|||
{"shape":"OperationInProgressException"},
|
||||
{"shape":"S3LocationNotInServiceRegionException"}
|
||||
],
|
||||
"documentation":"<p> Deletes the specified version from the specified application. </p> <note>You cannot delete an application version that is associated with a running environment.</note>"
|
||||
"documentation":"<p>Deletes the specified version from the specified application.</p> <note> <p>You cannot delete an application version that is associated with a running environment.</p> </note>"
|
||||
},
|
||||
"DeleteConfigurationTemplate":{
|
||||
"name":"DeleteConfigurationTemplate",
|
||||
|
|
@ -193,7 +193,7 @@
|
|||
"errors":[
|
||||
{"shape":"OperationInProgressException"}
|
||||
],
|
||||
"documentation":"<p>Deletes the specified configuration template.</p> <note>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.</note>"
|
||||
"documentation":"<p>Deletes the specified configuration template.</p> <note> <p>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.</p> </note>"
|
||||
},
|
||||
"DeleteEnvironmentConfiguration":{
|
||||
"name":"DeleteEnvironmentConfiguration",
|
||||
|
|
@ -244,7 +244,7 @@
|
|||
"errors":[
|
||||
{"shape":"TooManyBucketsException"}
|
||||
],
|
||||
"documentation":"<p> 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. </p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"DescribeConfigurationSettings":{
|
||||
"name":"DescribeConfigurationSettings",
|
||||
|
|
@ -260,7 +260,7 @@
|
|||
"errors":[
|
||||
{"shape":"TooManyBucketsException"}
|
||||
],
|
||||
"documentation":"<p> 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. </p> <p> 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. </p> <p>Related Topics</p> <ul> <li> <a>DeleteEnvironmentConfiguration</a> </li> </ul>"
|
||||
"documentation":"<p>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.</p> <p>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.</p> <p>Related Topics</p> <ul> <li> <p> <a>DeleteEnvironmentConfiguration</a> </p> </li> </ul>"
|
||||
},
|
||||
"DescribeEnvironmentHealth":{
|
||||
"name":"DescribeEnvironmentHealth",
|
||||
|
|
@ -351,7 +351,7 @@
|
|||
"shape":"EventDescriptionsMessage",
|
||||
"resultWrapper":"DescribeEventsResult"
|
||||
},
|
||||
"documentation":"<p>Returns list of event descriptions matching criteria up to the last 6 weeks.</p> <note>This action returns the most recent 1,000 events from the specified <code>NextToken</code>.</note>"
|
||||
"documentation":"<p>Returns list of event descriptions matching criteria up to the last 6 weeks.</p> <note> <p>This action returns the most recent 1,000 events from the specified <code>NextToken</code>.</p> </note>"
|
||||
},
|
||||
"DescribeInstancesHealth":{
|
||||
"name":"DescribeInstancesHealth",
|
||||
|
|
@ -380,7 +380,7 @@
|
|||
"shape":"ListAvailableSolutionStacksResultMessage",
|
||||
"resultWrapper":"ListAvailableSolutionStacksResult"
|
||||
},
|
||||
"documentation":"<p> Returns a list of the available solution stack names. </p>"
|
||||
"documentation":"<p>Returns a list of the available solution stack names.</p>"
|
||||
},
|
||||
"RebuildEnvironment":{
|
||||
"name":"RebuildEnvironment",
|
||||
|
|
@ -392,7 +392,7 @@
|
|||
"errors":[
|
||||
{"shape":"InsufficientPrivilegesException"}
|
||||
],
|
||||
"documentation":"<p> 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. </p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"RequestEnvironmentInfo":{
|
||||
"name":"RequestEnvironmentInfo",
|
||||
|
|
@ -401,7 +401,7 @@
|
|||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"RequestEnvironmentInfoMessage"},
|
||||
"documentation":"<p> Initiates a request to compile the specified type of information of the deployed environment. </p> <p> Setting the <code>InfoType</code> to <code>tail</code> compiles the last lines from the application server log files of every Amazon EC2 instance in your environment. </p> <p> Setting the <code>InfoType</code> to <code>bundle</code> compresses the application server log files for every Amazon EC2 instance into a <code>.zip</code> file. Legacy and .NET containers do not support bundle logs. </p> <p> Use <a>RetrieveEnvironmentInfo</a> to obtain the set of logs. </p> <p>Related Topics</p> <ul> <li> <a>RetrieveEnvironmentInfo</a> </li> </ul>"
|
||||
"documentation":"<p>Initiates a request to compile the specified type of information of the deployed environment.</p> <p> Setting the <code>InfoType</code> to <code>tail</code> compiles the last lines from the application server log files of every Amazon EC2 instance in your environment. </p> <p> Setting the <code>InfoType</code> to <code>bundle</code> compresses the application server log files for every Amazon EC2 instance into a <code>.zip</code> file. Legacy and .NET containers do not support bundle logs. </p> <p> Use <a>RetrieveEnvironmentInfo</a> to obtain the set of logs. </p> <p>Related Topics</p> <ul> <li> <p> <a>RetrieveEnvironmentInfo</a> </p> </li> </ul>"
|
||||
},
|
||||
"RestartAppServer":{
|
||||
"name":"RestartAppServer",
|
||||
|
|
@ -423,7 +423,7 @@
|
|||
"shape":"RetrieveEnvironmentInfoResultMessage",
|
||||
"resultWrapper":"RetrieveEnvironmentInfoResult"
|
||||
},
|
||||
"documentation":"<p>Retrieves the compiled information from a <a>RequestEnvironmentInfo</a> request.</p> <p>Related Topics</p> <ul> <li> <a>RequestEnvironmentInfo</a> </li> </ul>"
|
||||
"documentation":"<p>Retrieves the compiled information from a <a>RequestEnvironmentInfo</a> request.</p> <p>Related Topics</p> <ul> <li> <p> <a>RequestEnvironmentInfo</a> </p> </li> </ul>"
|
||||
},
|
||||
"SwapEnvironmentCNAMEs":{
|
||||
"name":"SwapEnvironmentCNAMEs",
|
||||
|
|
@ -432,7 +432,7 @@
|
|||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"SwapEnvironmentCNAMEsMessage"},
|
||||
"documentation":"<p> Swaps the CNAMEs of two environments. </p>"
|
||||
"documentation":"<p>Swaps the CNAMEs of two environments.</p>"
|
||||
},
|
||||
"TerminateEnvironment":{
|
||||
"name":"TerminateEnvironment",
|
||||
|
|
@ -448,7 +448,7 @@
|
|||
"errors":[
|
||||
{"shape":"InsufficientPrivilegesException"}
|
||||
],
|
||||
"documentation":"<p> Terminates the specified environment. </p>"
|
||||
"documentation":"<p>Terminates the specified environment.</p>"
|
||||
},
|
||||
"UpdateApplication":{
|
||||
"name":"UpdateApplication",
|
||||
|
|
@ -461,7 +461,7 @@
|
|||
"shape":"ApplicationDescriptionMessage",
|
||||
"resultWrapper":"UpdateApplicationResult"
|
||||
},
|
||||
"documentation":"<p>Updates the specified application to have the specified properties. </p> <note> If a property (for example, <code>description</code>) is not provided, the value remains unchanged. To clear these properties, specify an empty string. </note>"
|
||||
"documentation":"<p>Updates the specified application to have the specified properties.</p> <note> <p>If a property (for example, <code>description</code>) is not provided, the value remains unchanged. To clear these properties, specify an empty string.</p> </note>"
|
||||
},
|
||||
"UpdateApplicationVersion":{
|
||||
"name":"UpdateApplicationVersion",
|
||||
|
|
@ -474,7 +474,7 @@
|
|||
"shape":"ApplicationVersionDescriptionMessage",
|
||||
"resultWrapper":"UpdateApplicationVersionResult"
|
||||
},
|
||||
"documentation":"<p> Updates the specified application version to have the specified properties. </p> <note> If a property (for example, <code>description</code>) is not provided, the value remains unchanged. To clear properties, specify an empty string. </note>"
|
||||
"documentation":"<p>Updates the specified application version to have the specified properties.</p> <note> <p>If a property (for example, <code>description</code>) is not provided, the value remains unchanged. To clear properties, specify an empty string.</p> </note>"
|
||||
},
|
||||
"UpdateConfigurationTemplate":{
|
||||
"name":"UpdateConfigurationTemplate",
|
||||
|
|
@ -491,7 +491,7 @@
|
|||
{"shape":"InsufficientPrivilegesException"},
|
||||
{"shape":"TooManyBucketsException"}
|
||||
],
|
||||
"documentation":"<p> Updates the specified configuration template to have the specified properties or configuration option values. </p> <note> If a property (for example, <code>ApplicationName</code>) is not provided, its value remains unchanged. To clear such properties, specify an empty string. </note> <p>Related Topics</p> <ul> <li> <a>DescribeConfigurationOptions</a> </li> </ul>"
|
||||
"documentation":"<p>Updates the specified configuration template to have the specified properties or configuration option values.</p> <note> <p>If a property (for example, <code>ApplicationName</code>) is not provided, its value remains unchanged. To clear such properties, specify an empty string.</p> </note> <p>Related Topics</p> <ul> <li> <p> <a>DescribeConfigurationOptions</a> </p> </li> </ul>"
|
||||
},
|
||||
"UpdateEnvironment":{
|
||||
"name":"UpdateEnvironment",
|
||||
|
|
@ -508,7 +508,7 @@
|
|||
{"shape":"InsufficientPrivilegesException"},
|
||||
{"shape":"TooManyBucketsException"}
|
||||
],
|
||||
"documentation":"<p> 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. </p> <p> Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. </p> <p> When updating the configuration settings to a new template or individual settings, a draft configuration is created and <a>DescribeConfigurationSettings</a> for this environment returns two setting descriptions with different <code>DeploymentStatus</code> values. </p>"
|
||||
"documentation":"<p>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.</p> <p> Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. </p> <p> When updating the configuration settings to a new template or individual settings, a draft configuration is created and <a>DescribeConfigurationSettings</a> for this environment returns two setting descriptions with different <code>DeploymentStatus</code> values. </p>"
|
||||
},
|
||||
"ValidateConfigurationSettings":{
|
||||
"name":"ValidateConfigurationSettings",
|
||||
|
|
@ -525,7 +525,7 @@
|
|||
{"shape":"InsufficientPrivilegesException"},
|
||||
{"shape":"TooManyBucketsException"}
|
||||
],
|
||||
"documentation":"<p> Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid. </p> <p> This action returns a list of messages indicating any errors or warnings associated with the selection of option values. </p>"
|
||||
"documentation":"<p>Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.</p> <p>This action returns a list of messages indicating any errors or warnings associated with the selection of option values.</p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
|
|
@ -594,7 +594,7 @@
|
|||
},
|
||||
"ConfigurationTemplates":{
|
||||
"shape":"ConfigurationTemplateNamesList",
|
||||
"documentation":"<p> The names of the configuration templates associated with this application. </p>"
|
||||
"documentation":"<p>The names of the configuration templates associated with this application.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes the properties of an application.</p>"
|
||||
|
|
@ -667,11 +667,12 @@
|
|||
},
|
||||
"VersionLabel":{
|
||||
"shape":"VersionLabel",
|
||||
"documentation":"<p> A label uniquely identifying the version for the associated application. </p>"
|
||||
"documentation":"<p>A label uniquely identifying the version for the associated application.</p>"
|
||||
},
|
||||
"SourceBuildInformation":{"shape":"SourceBuildInformation"},
|
||||
"SourceBundle":{
|
||||
"shape":"S3Location",
|
||||
"documentation":"<p> The location where the source bundle is located for this version. </p>"
|
||||
"documentation":"<p>The location where the source bundle is located for this version.</p>"
|
||||
},
|
||||
"DateCreated":{
|
||||
"shape":"CreationDate",
|
||||
|
|
@ -686,7 +687,7 @@
|
|||
"documentation":"<p>The processing status of the application version.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Describes the properties of an application version. </p>"
|
||||
"documentation":"<p>Describes the properties of an application version.</p>"
|
||||
},
|
||||
"ApplicationVersionDescriptionList":{
|
||||
"type":"list",
|
||||
|
|
@ -700,7 +701,7 @@
|
|||
"documentation":"<p> The <a>ApplicationVersionDescription</a> of the application version. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result message wrapping a single description of an application version. </p>"
|
||||
"documentation":"<p>Result message wrapping a single description of an application version.</p>"
|
||||
},
|
||||
"ApplicationVersionDescriptionsMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -708,6 +709,10 @@
|
|||
"ApplicationVersions":{
|
||||
"shape":"ApplicationVersionDescriptionList",
|
||||
"documentation":"<p>List of <code>ApplicationVersionDescription</code> objects sorted by order of creation.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p>For a paginated request, the token that you can pass in a subsequent request to get the next page.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Result message wrapping a list of application version descriptions.</p>"
|
||||
|
|
@ -772,7 +777,7 @@
|
|||
"documentation":"<p>The name of the <code>AutoScalingGroup</code> . </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes an Auto Scaling launch configuration. </p>"
|
||||
"documentation":"<p>Describes an Auto Scaling launch configuration.</p>"
|
||||
},
|
||||
"AutoScalingGroupList":{
|
||||
"type":"list",
|
||||
|
|
@ -835,7 +840,7 @@
|
|||
"members":{
|
||||
"CNAMEPrefix":{
|
||||
"shape":"DNSCnamePrefix",
|
||||
"documentation":"<p> The prefix used when this CNAME is reserved. </p>"
|
||||
"documentation":"<p>The prefix used when this CNAME is reserved.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Results message indicating whether a CNAME is available.</p>"
|
||||
|
|
@ -845,7 +850,7 @@
|
|||
"members":{
|
||||
"Available":{
|
||||
"shape":"CnameAvailability",
|
||||
"documentation":"<p> Indicates if the specified CNAME is available: </p> <ul> <li> <code>true</code> : The CNAME is available. </li> <li> <code>false</code> : The CNAME is not available. </li> </ul>"
|
||||
"documentation":"<p>Indicates if the specified CNAME is available:</p> <ul> <li> <p> <code>true</code> : The CNAME is available.</p> </li> <li> <p> <code>false</code> : The CNAME is not available.</p> </li> </ul>"
|
||||
},
|
||||
"FullyQualifiedCNAME":{
|
||||
"shape":"DNSCname",
|
||||
|
|
@ -887,50 +892,50 @@
|
|||
"members":{
|
||||
"Namespace":{
|
||||
"shape":"OptionNamespace",
|
||||
"documentation":"<p> A unique namespace identifying the option's associated AWS resource. </p>"
|
||||
"documentation":"<p>A unique namespace identifying the option's associated AWS resource.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"ConfigurationOptionName",
|
||||
"documentation":"<p> The name of the configuration option. </p>"
|
||||
"documentation":"<p>The name of the configuration option.</p>"
|
||||
},
|
||||
"DefaultValue":{
|
||||
"shape":"ConfigurationOptionDefaultValue",
|
||||
"documentation":"<p> The default value for this configuration option. </p>"
|
||||
"documentation":"<p>The default value for this configuration option.</p>"
|
||||
},
|
||||
"ChangeSeverity":{
|
||||
"shape":"ConfigurationOptionSeverity",
|
||||
"documentation":"<p> An indication of which action is required if the value for this configuration option changes: </p> <ul> <li> <code>NoInterruption</code> : There is no interruption to the environment or application availability. </li> <li> <code>RestartEnvironment</code> : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process. </li> <li> <code>RestartApplicationServer</code> : 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. </li> </ul>"
|
||||
"documentation":"<p>An indication of which action is required if the value for this configuration option changes:</p> <ul> <li> <p> <code>NoInterruption</code> : There is no interruption to the environment or application availability.</p> </li> <li> <p> <code>RestartEnvironment</code> : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.</p> </li> <li> <p> <code>RestartApplicationServer</code> : 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.</p> </li> </ul>"
|
||||
},
|
||||
"UserDefined":{
|
||||
"shape":"UserDefinedOption",
|
||||
"documentation":"<p> An indication of whether the user defined this configuration option: </p> <ul> <li> <p> <code>true</code> : This configuration option was defined by the user. It is a valid choice for specifying if this as an <code>Option to Remove</code> when updating configuration settings. </p> </li> <li> <code>false</code> : This configuration was not defined by the user. </li> </ul> <p> Constraint: You can remove only <code>UserDefined</code> options from a configuration. </p> <p> Valid Values: <code>true</code> | <code>false</code></p>"
|
||||
"documentation":"<p>An indication of whether the user defined this configuration option:</p> <ul> <li> <p> <code>true</code> : This configuration option was defined by the user. It is a valid choice for specifying if this as an <code>Option to Remove</code> when updating configuration settings. </p> </li> <li> <p> <code>false</code> : This configuration was not defined by the user.</p> </li> </ul> <p> Constraint: You can remove only <code>UserDefined</code> options from a configuration. </p> <p> Valid Values: <code>true</code> | <code>false</code> </p>"
|
||||
},
|
||||
"ValueType":{
|
||||
"shape":"ConfigurationOptionValueType",
|
||||
"documentation":"<p> 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: </p> <ul> <li> <code>Scalar</code> : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the <code>MIN/MAX/Regex</code> constraints. </li> <li> <code>List</code> : Values for this option are multiple selections from the possible values. </li> <li> <code>Boolean</code> : Values for this option are either <code>true</code> or <code>false</code> . </li> <li> <code>Json</code> : Values for this option are a JSON representation of a <code>ConfigDocument</code>. </li> </ul>"
|
||||
"documentation":"<p>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:</p> <ul> <li> <p> <code>Scalar</code> : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the <code>MIN/MAX/Regex</code> constraints.</p> </li> <li> <p> <code>List</code> : Values for this option are multiple selections from the possible values.</p> </li> <li> <p> <code>Boolean</code> : Values for this option are either <code>true</code> or <code>false</code> .</p> </li> <li> <p> <code>Json</code> : Values for this option are a JSON representation of a <code>ConfigDocument</code>.</p> </li> </ul>"
|
||||
},
|
||||
"ValueOptions":{
|
||||
"shape":"ConfigurationOptionPossibleValues",
|
||||
"documentation":"<p> If specified, values for the configuration option are selected from this list. </p>"
|
||||
"documentation":"<p>If specified, values for the configuration option are selected from this list.</p>"
|
||||
},
|
||||
"MinValue":{
|
||||
"shape":"OptionRestrictionMinValue",
|
||||
"documentation":"<p> If specified, the configuration option must be a numeric value greater than this value. </p>"
|
||||
"documentation":"<p>If specified, the configuration option must be a numeric value greater than this value.</p>"
|
||||
},
|
||||
"MaxValue":{
|
||||
"shape":"OptionRestrictionMaxValue",
|
||||
"documentation":"<p> If specified, the configuration option must be a numeric value less than this value. </p>"
|
||||
"documentation":"<p>If specified, the configuration option must be a numeric value less than this value.</p>"
|
||||
},
|
||||
"MaxLength":{
|
||||
"shape":"OptionRestrictionMaxLength",
|
||||
"documentation":"<p> If specified, the configuration option must be a string value no longer than this value. </p>"
|
||||
"documentation":"<p>If specified, the configuration option must be a string value no longer than this value.</p>"
|
||||
},
|
||||
"Regex":{
|
||||
"shape":"OptionRestrictionRegex",
|
||||
"documentation":"<p> If specified, the configuration option must be a string value that satisfies this regular expression. </p>"
|
||||
"documentation":"<p>If specified, the configuration option must be a string value that satisfies this regular expression.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Describes the possible values for a configuration option. </p>"
|
||||
"documentation":"<p>Describes the possible values for a configuration option.</p>"
|
||||
},
|
||||
"ConfigurationOptionDescriptionsList":{
|
||||
"type":"list",
|
||||
|
|
@ -947,19 +952,19 @@
|
|||
"members":{
|
||||
"ResourceName":{
|
||||
"shape":"ResourceName",
|
||||
"documentation":"<p> A unique resource name for a time-based scaling configuration option. </p>"
|
||||
"documentation":"<p>A unique resource name for a time-based scaling configuration option.</p>"
|
||||
},
|
||||
"Namespace":{
|
||||
"shape":"OptionNamespace",
|
||||
"documentation":"<p> A unique namespace identifying the option's associated AWS resource. </p>"
|
||||
"documentation":"<p>A unique namespace identifying the option's associated AWS resource.</p>"
|
||||
},
|
||||
"OptionName":{
|
||||
"shape":"ConfigurationOptionName",
|
||||
"documentation":"<p> The name of the configuration option. </p>"
|
||||
"documentation":"<p>The name of the configuration option.</p>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"ConfigurationOptionValue",
|
||||
"documentation":"<p> The current value for the configuration option. </p>"
|
||||
"documentation":"<p>The current value for the configuration option.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to <a href=\"http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html\">Option Values</a> in the <i>AWS Elastic Beanstalk Developer Guide</i>. </p>"
|
||||
|
|
@ -982,7 +987,7 @@
|
|||
"members":{
|
||||
"SolutionStackName":{
|
||||
"shape":"SolutionStackName",
|
||||
"documentation":"<p> The name of the solution stack these configuration options belong to. </p>"
|
||||
"documentation":"<p>The name of the solution stack these configuration options belong to.</p>"
|
||||
},
|
||||
"Options":{
|
||||
"shape":"ConfigurationOptionDescriptionsList",
|
||||
|
|
@ -996,11 +1001,11 @@
|
|||
"members":{
|
||||
"SolutionStackName":{
|
||||
"shape":"SolutionStackName",
|
||||
"documentation":"<p> The name of the solution stack this configuration set uses. </p>"
|
||||
"documentation":"<p>The name of the solution stack this configuration set uses.</p>"
|
||||
},
|
||||
"ApplicationName":{
|
||||
"shape":"ApplicationName",
|
||||
"documentation":"<p> The name of the application associated with this configuration set. </p>"
|
||||
"documentation":"<p>The name of the application associated with this configuration set.</p>"
|
||||
},
|
||||
"TemplateName":{
|
||||
"shape":"ConfigurationTemplateName",
|
||||
|
|
@ -1008,7 +1013,7 @@
|
|||
},
|
||||
"Description":{
|
||||
"shape":"Description",
|
||||
"documentation":"<p> Describes this configuration set. </p>"
|
||||
"documentation":"<p>Describes this configuration set.</p>"
|
||||
},
|
||||
"EnvironmentName":{
|
||||
"shape":"EnvironmentName",
|
||||
|
|
@ -1016,22 +1021,22 @@
|
|||
},
|
||||
"DeploymentStatus":{
|
||||
"shape":"ConfigurationDeploymentStatus",
|
||||
"documentation":"<p> If this configuration set is associated with an environment, the <code>DeploymentStatus</code> parameter indicates the deployment status of this configuration set: </p> <ul> <li> <code>null</code>: This configuration is not associated with a running environment. </li> <li> <code>pending</code>: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying. </li> <li> <code>deployed</code>: This is the configuration that is currently deployed to the associated running environment. </li> <li> <code>failed</code>: This is a draft configuration that failed to successfully deploy. </li> </ul>"
|
||||
"documentation":"<p> If this configuration set is associated with an environment, the <code>DeploymentStatus</code> parameter indicates the deployment status of this configuration set: </p> <ul> <li> <p> <code>null</code>: This configuration is not associated with a running environment.</p> </li> <li> <p> <code>pending</code>: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.</p> </li> <li> <p> <code>deployed</code>: This is the configuration that is currently deployed to the associated running environment.</p> </li> <li> <p> <code>failed</code>: This is a draft configuration that failed to successfully deploy.</p> </li> </ul>"
|
||||
},
|
||||
"DateCreated":{
|
||||
"shape":"CreationDate",
|
||||
"documentation":"<p> The date (in UTC time) when this configuration set was created. </p>"
|
||||
"documentation":"<p>The date (in UTC time) when this configuration set was created.</p>"
|
||||
},
|
||||
"DateUpdated":{
|
||||
"shape":"UpdateDate",
|
||||
"documentation":"<p> The date (in UTC time) when this configuration set was last modified. </p>"
|
||||
"documentation":"<p>The date (in UTC time) when this configuration set was last modified.</p>"
|
||||
},
|
||||
"OptionSettings":{
|
||||
"shape":"ConfigurationOptionSettingsList",
|
||||
"documentation":"<p> A list of the configuration options and their values in this configuration set. </p>"
|
||||
"documentation":"<p>A list of the configuration options and their values in this configuration set.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Describes the settings for a configuration set. </p>"
|
||||
"documentation":"<p>Describes the settings for a configuration set.</p>"
|
||||
},
|
||||
"ConfigurationSettingsDescriptionList":{
|
||||
"type":"list",
|
||||
|
|
@ -1100,13 +1105,14 @@
|
|||
"shape":"Description",
|
||||
"documentation":"<p>Describes this version.</p>"
|
||||
},
|
||||
"SourceBuildInformation":{"shape":"SourceBuildInformation"},
|
||||
"SourceBundle":{
|
||||
"shape":"S3Location",
|
||||
"documentation":"<p> The Amazon S3 bucket and key that identify the location of the source bundle for this version. </p> <p> If data found at the Amazon S3 location exceeds the maximum allowed source bundle size, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. The maximum size allowed is 512 MB. </p> <p>Default: If not specified, AWS Elastic Beanstalk uses a sample application. If only partially specified (for example, a bucket is provided but not the key) or if no data is found at the Amazon S3 location, AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. </p>"
|
||||
"documentation":"<p>The Amazon S3 bucket and key that identify the location of the source bundle for this version.</p> <p> If data found at the Amazon S3 location exceeds the maximum allowed source bundle size, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. The maximum size allowed is 512 MB. </p> <p>Default: If not specified, AWS Elastic Beanstalk uses a sample application. If only partially specified (for example, a bucket is provided but not the key) or if no data is found at the Amazon S3 location, AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. </p>"
|
||||
},
|
||||
"AutoCreateApplication":{
|
||||
"shape":"AutoCreateApplication",
|
||||
"documentation":"<p> Determines how the system behaves if the specified application for this version does not already exist: </p> <ul> <li> <code>true</code> : Automatically creates the specified application for this release if it does not already exist. </li> <li> <code>false</code> : Throws an <code>InvalidParameterValue</code> if the specified application for this release does not already exist. </li> </ul> <p> Default: <code>false</code> </p> <p> Valid Values: <code>true</code> | <code>false</code> </p>"
|
||||
"documentation":"<p>Determines how the system behaves if the specified application for this version does not already exist:</p> <ul> <li> <p> <code>true</code> : Automatically creates the specified application for this release if it does not already exist.</p> </li> <li> <p> <code>false</code> : Throws an <code>InvalidParameterValue</code> if the specified application for this release does not already exist.</p> </li> </ul> <p> Default: <code>false</code> </p> <p> Valid Values: <code>true</code> | <code>false</code> </p>"
|
||||
},
|
||||
"Process":{
|
||||
"shape":"ApplicationVersionProccess",
|
||||
|
|
@ -1128,15 +1134,15 @@
|
|||
},
|
||||
"TemplateName":{
|
||||
"shape":"ConfigurationTemplateName",
|
||||
"documentation":"<p>The name of the configuration template.</p> <p>Constraint: This name must be unique per application. </p> <p>Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </p>"
|
||||
"documentation":"<p>The name of the configuration template.</p> <p>Constraint: This name must be unique per application.</p> <p>Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </p>"
|
||||
},
|
||||
"SolutionStackName":{
|
||||
"shape":"SolutionStackName",
|
||||
"documentation":"<p>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. </p> <p> Use <a>ListAvailableSolutionStacks</a> to obtain a list of available solution stacks. </p> <p> A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </p> <p> 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. </p>"
|
||||
"documentation":"<p>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.</p> <p> Use <a>ListAvailableSolutionStacks</a> to obtain a list of available solution stacks. </p> <p> A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </p> <p>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.</p>"
|
||||
},
|
||||
"SourceConfiguration":{
|
||||
"shape":"SourceConfiguration",
|
||||
"documentation":"<p> If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration. </p> <p> Values specified in the <code>OptionSettings</code> parameter of this call overrides any values obtained from the <code>SourceConfiguration</code>. </p> <p> If no configuration template is found, returns an <code>InvalidParameterValue</code> error. </p> <p> 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 <code>InvalidParameterCombination</code> error. </p>"
|
||||
"documentation":"<p>If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.</p> <p> Values specified in the <code>OptionSettings</code> parameter of this call overrides any values obtained from the <code>SourceConfiguration</code>. </p> <p> If no configuration template is found, returns an <code>InvalidParameterValue</code> error. </p> <p> 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 <code>InvalidParameterCombination</code> error. </p>"
|
||||
},
|
||||
"EnvironmentId":{
|
||||
"shape":"EnvironmentId",
|
||||
|
|
@ -1148,7 +1154,7 @@
|
|||
},
|
||||
"OptionSettings":{
|
||||
"shape":"ConfigurationOptionSettingsList",
|
||||
"documentation":"<p> 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. </p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Request to create a configuration template.</p>"
|
||||
|
|
@ -1159,11 +1165,11 @@
|
|||
"members":{
|
||||
"ApplicationName":{
|
||||
"shape":"ApplicationName",
|
||||
"documentation":"<p> The name of the application that contains the version to be deployed. </p> <p> If no application is found with this name, <code>CreateEnvironment</code> returns an <code>InvalidParameterValue</code> error. </p>"
|
||||
"documentation":"<p>The name of the application that contains the version to be deployed.</p> <p> If no application is found with this name, <code>CreateEnvironment</code> returns an <code>InvalidParameterValue</code> error. </p>"
|
||||
},
|
||||
"EnvironmentName":{
|
||||
"shape":"EnvironmentName",
|
||||
"documentation":"<p> A unique name for the deployment environment. Used in the application URL. </p> <p>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 <code>InvalidParameterValue</code> error. </p> <p>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.</p>"
|
||||
"documentation":"<p>A unique name for the deployment environment. Used in the application URL.</p> <p>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 <code>InvalidParameterValue</code> error. </p> <p>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.</p>"
|
||||
},
|
||||
"GroupName":{
|
||||
"shape":"GroupName",
|
||||
|
|
@ -1175,19 +1181,19 @@
|
|||
},
|
||||
"CNAMEPrefix":{
|
||||
"shape":"DNSCnamePrefix",
|
||||
"documentation":"<p> 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. </p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"Tier":{
|
||||
"shape":"EnvironmentTier",
|
||||
"documentation":"<p> This specifies the tier to use for creating this environment. </p>"
|
||||
"documentation":"<p>This specifies the tier to use for creating this environment.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p> This specifies the tags applied to resources in the environment. </p>"
|
||||
"documentation":"<p>This specifies the tags applied to resources in the environment.</p>"
|
||||
},
|
||||
"VersionLabel":{
|
||||
"shape":"VersionLabel",
|
||||
"documentation":"<p>The name of the application version to deploy.</p> <p> If the specified application has no associated application versions, AWS Elastic Beanstalk <code>UpdateEnvironment</code> returns an <code>InvalidParameterValue</code> error. </p> <p> Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container. </p>"
|
||||
"documentation":"<p>The name of the application version to deploy.</p> <p> If the specified application has no associated application versions, AWS Elastic Beanstalk <code>UpdateEnvironment</code> returns an <code>InvalidParameterValue</code> error. </p> <p>Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.</p>"
|
||||
},
|
||||
"TemplateName":{
|
||||
"shape":"ConfigurationTemplateName",
|
||||
|
|
@ -1195,15 +1201,15 @@
|
|||
},
|
||||
"SolutionStackName":{
|
||||
"shape":"SolutionStackName",
|
||||
"documentation":"<p> 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. </p> <p> Condition: You must specify either this or a <code>TemplateName</code>, but not both. If you specify both, AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. If you do not specify either, AWS Elastic Beanstalk returns a <code>MissingRequiredParameter</code> error. </p>"
|
||||
"documentation":"<p>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.</p> <p> Condition: You must specify either this or a <code>TemplateName</code>, but not both. If you specify both, AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. If you do not specify either, AWS Elastic Beanstalk returns a <code>MissingRequiredParameter</code> error. </p>"
|
||||
},
|
||||
"OptionSettings":{
|
||||
"shape":"ConfigurationOptionSettingsList",
|
||||
"documentation":"<p> 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. </p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"OptionsToRemove":{
|
||||
"shape":"OptionsSpecifierList",
|
||||
"documentation":"<p> A list of custom user-defined configuration options to remove from the configuration set for this new environment. </p>"
|
||||
"documentation":"<p>A list of custom user-defined configuration options to remove from the configuration set for this new environment.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
|
|
@ -1213,7 +1219,7 @@
|
|||
"members":{
|
||||
"S3Bucket":{
|
||||
"shape":"S3Bucket",
|
||||
"documentation":"<p> The name of the Amazon S3 bucket created. </p>"
|
||||
"documentation":"<p>The name of the Amazon S3 bucket created.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Results of a <a>CreateStorageLocationResult</a> call.</p>"
|
||||
|
|
@ -1261,7 +1267,7 @@
|
|||
},
|
||||
"DeleteSourceBundle":{
|
||||
"shape":"DeleteSourceBundle",
|
||||
"documentation":"<p>Indicates whether to delete the associated source bundle from Amazon S3: </p> <ul> <li> <code>true</code>: An attempt is made to delete the associated Amazon S3 source bundle specified at time of creation. </li> <li> <code>false</code>: No action is taken on the Amazon S3 source bundle specified at time of creation. </li> </ul> <p> Valid Values: <code>true</code> | <code>false</code> </p>"
|
||||
"documentation":"<p>Indicates whether to delete the associated source bundle from Amazon S3:</p> <ul> <li> <p> <code>true</code>: An attempt is made to delete the associated Amazon S3 source bundle specified at time of creation.</p> </li> <li> <p> <code>false</code>: No action is taken on the Amazon S3 source bundle specified at time of creation.</p> </li> </ul> <p> Valid Values: <code>true</code> | <code>false</code> </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Request to delete an application version.</p>"
|
||||
|
|
@ -1275,7 +1281,7 @@
|
|||
"members":{
|
||||
"ApplicationName":{
|
||||
"shape":"ApplicationName",
|
||||
"documentation":"<p> The name of the application to delete the configuration template from.</p>"
|
||||
"documentation":"<p>The name of the application to delete the configuration template from.</p>"
|
||||
},
|
||||
"TemplateName":{
|
||||
"shape":"ConfigurationTemplateName",
|
||||
|
|
@ -1316,7 +1322,7 @@
|
|||
},
|
||||
"Status":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The status of the deployment:</p> <ul> <li> <code>In Progress</code> : The deployment is in progress.</li> <li> <code>Deployed</code> : The deployment succeeded.</li> <li> <code>Failed</code> : The deployment failed.</li> </ul>"
|
||||
"documentation":"<p>The status of the deployment:</p> <ul> <li> <p> <code>In Progress</code> : The deployment is in progress.</p> </li> <li> <p> <code>Deployed</code> : The deployment succeeded.</p> </li> <li> <p> <code>Failed</code> : The deployment failed.</p> </li> </ul>"
|
||||
},
|
||||
"DeploymentTime":{
|
||||
"shape":"DeploymentTimestamp",
|
||||
|
|
@ -1336,6 +1342,14 @@
|
|||
"VersionLabels":{
|
||||
"shape":"VersionLabelsList",
|
||||
"documentation":"<p>If specified, restricts the returned descriptions to only include ones that have the specified version labels.</p>"
|
||||
},
|
||||
"MaxRecords":{
|
||||
"shape":"MaxRecords",
|
||||
"documentation":"<p>Specify a maximum number of application versions to paginate in the request.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p>Specify a next token to retrieve the next page in a paginated request.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Result message containing a list of configuration descriptions.</p>"
|
||||
|
|
@ -1345,7 +1359,7 @@
|
|||
"members":{
|
||||
"ApplicationNames":{
|
||||
"shape":"ApplicationNamesList",
|
||||
"documentation":"<p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names. </p>"
|
||||
"documentation":"<p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Request to describe one or more applications.</p>"
|
||||
|
|
@ -1355,26 +1369,26 @@
|
|||
"members":{
|
||||
"ApplicationName":{
|
||||
"shape":"ApplicationName",
|
||||
"documentation":"<p> 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. </p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"TemplateName":{
|
||||
"shape":"ConfigurationTemplateName",
|
||||
"documentation":"<p> The name of the configuration template whose configuration options you want to describe. </p>"
|
||||
"documentation":"<p>The name of the configuration template whose configuration options you want to describe.</p>"
|
||||
},
|
||||
"EnvironmentName":{
|
||||
"shape":"EnvironmentName",
|
||||
"documentation":"<p> The name of the environment whose configuration options you want to describe. </p>"
|
||||
"documentation":"<p>The name of the environment whose configuration options you want to describe.</p>"
|
||||
},
|
||||
"SolutionStackName":{
|
||||
"shape":"SolutionStackName",
|
||||
"documentation":"<p> The name of the solution stack whose configuration options you want to describe. </p>"
|
||||
"documentation":"<p>The name of the solution stack whose configuration options you want to describe.</p>"
|
||||
},
|
||||
"Options":{
|
||||
"shape":"OptionsSpecifierList",
|
||||
"documentation":"<p> If specified, restricts the descriptions to only the specified options. </p>"
|
||||
"documentation":"<p>If specified, restricts the descriptions to only the specified options.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Result message containig a list of application version descriptions. </p>"
|
||||
"documentation":"<p>Result message containig a list of application version descriptions.</p>"
|
||||
},
|
||||
"DescribeConfigurationSettingsMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -1382,15 +1396,15 @@
|
|||
"members":{
|
||||
"ApplicationName":{
|
||||
"shape":"ApplicationName",
|
||||
"documentation":"<p> The application for the environment or configuration template. </p>"
|
||||
"documentation":"<p>The application for the environment or configuration template.</p>"
|
||||
},
|
||||
"TemplateName":{
|
||||
"shape":"ConfigurationTemplateName",
|
||||
"documentation":"<p> The name of the configuration template to describe. </p> <p> Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. If you do not specify either, AWS Elastic Beanstalk returns a <code>MissingRequiredParameter</code> error. </p>"
|
||||
"documentation":"<p>The name of the configuration template to describe.</p> <p> Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. If you do not specify either, AWS Elastic Beanstalk returns a <code>MissingRequiredParameter</code> error. </p>"
|
||||
},
|
||||
"EnvironmentName":{
|
||||
"shape":"EnvironmentName",
|
||||
"documentation":"<p> The name of the environment to describe. </p> <p> Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>"
|
||||
"documentation":"<p>The name of the environment to describe.</p> <p> Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Result message containing all of the configuration settings for a specified solution stack or configuration template.</p>"
|
||||
|
|
@ -1514,11 +1528,11 @@
|
|||
"members":{
|
||||
"EnvironmentId":{
|
||||
"shape":"EnvironmentId",
|
||||
"documentation":"<p> The ID of the environment to retrieve AWS resource usage data. </p> <p> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>"
|
||||
"documentation":"<p>The ID of the environment to retrieve AWS resource usage data.</p> <p> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>"
|
||||
},
|
||||
"EnvironmentName":{
|
||||
"shape":"EnvironmentName",
|
||||
"documentation":"<p> The name of the environment to retrieve AWS resource usage data. </p> <p> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>"
|
||||
"documentation":"<p>The name of the environment to retrieve AWS resource usage data.</p> <p> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Request to describe the resources in an environment.</p>"
|
||||
|
|
@ -1578,11 +1592,11 @@
|
|||
},
|
||||
"RequestId":{
|
||||
"shape":"RequestId",
|
||||
"documentation":"<p> If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID. </p>"
|
||||
"documentation":"<p>If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.</p>"
|
||||
},
|
||||
"Severity":{
|
||||
"shape":"EventSeverity",
|
||||
"documentation":"<p> If specified, limits the events returned from this call to include only those with the specified severity or higher. </p>"
|
||||
"documentation":"<p>If specified, limits the events returned from this call to include only those with the specified severity or higher.</p>"
|
||||
},
|
||||
"StartTime":{
|
||||
"shape":"TimeFilterStart",
|
||||
|
|
@ -1594,11 +1608,11 @@
|
|||
},
|
||||
"MaxRecords":{
|
||||
"shape":"MaxRecords",
|
||||
"documentation":"<p> Specifies the maximum number of events that can be returned, beginning with the most recent event. </p>"
|
||||
"documentation":"<p>Specifies the maximum number of events that can be returned, beginning with the most recent event.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p> Pagination token. If specified, the events return the next batch of results. </p>"
|
||||
"documentation":"<p>Pagination token. If specified, the events return the next batch of results.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Request to retrieve a list of events for an environment.</p>"
|
||||
|
|
@ -1669,7 +1683,7 @@
|
|||
},
|
||||
"EnvironmentId":{
|
||||
"shape":"EnvironmentId",
|
||||
"documentation":"<p> The ID of this environment. </p>"
|
||||
"documentation":"<p>The ID of this environment.</p>"
|
||||
},
|
||||
"ApplicationName":{
|
||||
"shape":"ApplicationName",
|
||||
|
|
@ -1685,7 +1699,7 @@
|
|||
},
|
||||
"TemplateName":{
|
||||
"shape":"ConfigurationTemplateName",
|
||||
"documentation":"<p> The name of the configuration template used to originally launch this environment. </p>"
|
||||
"documentation":"<p>The name of the configuration template used to originally launch this environment.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"Description",
|
||||
|
|
@ -1697,7 +1711,7 @@
|
|||
},
|
||||
"CNAME":{
|
||||
"shape":"DNSCname",
|
||||
"documentation":"<p> The URL to the CNAME for this environment. </p>"
|
||||
"documentation":"<p>The URL to the CNAME for this environment.</p>"
|
||||
},
|
||||
"DateCreated":{
|
||||
"shape":"CreationDate",
|
||||
|
|
@ -1709,7 +1723,7 @@
|
|||
},
|
||||
"Status":{
|
||||
"shape":"EnvironmentStatus",
|
||||
"documentation":"<p> The current operational status of the environment: </p> <ul> <li> <code>Launching</code>: Environment is in the process of initial deployment. </li> <li> <code>Updating</code>: Environment is in the process of updating its configuration settings or application version. </li> <li> <code>Ready</code>: Environment is available to have an action performed on it, such as update or terminate. </li> <li> <code>Terminating</code>: Environment is in the shut-down process. </li> <li> <code>Terminated</code>: Environment is not running. </li> </ul>"
|
||||
"documentation":"<p>The current operational status of the environment:</p> <ul> <li> <p> <code>Launching</code>: Environment is in the process of initial deployment.</p> </li> <li> <p> <code>Updating</code>: Environment is in the process of updating its configuration settings or application version.</p> </li> <li> <p> <code>Ready</code>: Environment is available to have an action performed on it, such as update or terminate.</p> </li> <li> <p> <code>Terminating</code>: Environment is in the shut-down process.</p> </li> <li> <p> <code>Terminated</code>: Environment is not running.</p> </li> </ul>"
|
||||
},
|
||||
"AbortableOperationInProgress":{
|
||||
"shape":"AbortableOperationInProgress",
|
||||
|
|
@ -1717,7 +1731,7 @@
|
|||
},
|
||||
"Health":{
|
||||
"shape":"EnvironmentHealth",
|
||||
"documentation":"<p> Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment: </p> <ul> <li> <code>Red</code>: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment. </li> <li> <code>Yellow</code>: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment. </li> <li> <code>Green</code>: Indicates the environment is healthy and fully functional. </li> <li> <code>Grey</code>: 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 <code>UpdateEnvironment</code> or <code>RestartEnvironement</code> request. </li> </ul> <p> Default: <code>Grey</code> </p>"
|
||||
"documentation":"<p>Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:</p> <ul> <li> <p> <code>Red</code>: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.</p> </li> <li> <p> <code>Yellow</code>: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.</p> </li> <li> <p> <code>Green</code>: Indicates the environment is healthy and fully functional.</p> </li> <li> <p> <code>Grey</code>: 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 <code>UpdateEnvironment</code> or <code>RestartEnvironement</code> request.</p> </li> </ul> <p> Default: <code>Grey</code> </p>"
|
||||
},
|
||||
"HealthStatus":{
|
||||
"shape":"EnvironmentHealthStatus",
|
||||
|
|
@ -1885,7 +1899,7 @@
|
|||
},
|
||||
"Queues":{
|
||||
"shape":"QueueList",
|
||||
"documentation":"<p>The queues used by this environment. </p>"
|
||||
"documentation":"<p>The queues used by this environment.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes the AWS resources in use by this environment. This data is live.</p>"
|
||||
|
|
@ -1898,7 +1912,7 @@
|
|||
"documentation":"<p> A list of <a>EnvironmentResourceDescription</a>. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Result message containing a list of environment resource descriptions. </p>"
|
||||
"documentation":"<p>Result message containing a list of environment resource descriptions.</p>"
|
||||
},
|
||||
"EnvironmentResourcesDescription":{
|
||||
"type":"structure",
|
||||
|
|
@ -1936,7 +1950,7 @@
|
|||
"documentation":"<p>The version of this environment tier.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Describes the properties of an environment tier </p>"
|
||||
"documentation":"<p>Describes the properties of an environment tier</p>"
|
||||
},
|
||||
"EventDate":{"type":"timestamp"},
|
||||
"EventDescription":{
|
||||
|
|
@ -1972,7 +1986,7 @@
|
|||
},
|
||||
"Severity":{
|
||||
"shape":"EventSeverity",
|
||||
"documentation":"<p>The severity level of this event. </p>"
|
||||
"documentation":"<p>The severity level of this event.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes an event.</p>"
|
||||
|
|
@ -2052,35 +2066,35 @@
|
|||
"members":{
|
||||
"NoData":{
|
||||
"shape":"NullableInteger",
|
||||
"documentation":"<p><b>Grey.</b> AWS Elastic Beanstalk and the health agent are reporting no data on an instance.</p>"
|
||||
"documentation":"<p> <b>Grey.</b> AWS Elastic Beanstalk and the health agent are reporting no data on an instance.</p>"
|
||||
},
|
||||
"Unknown":{
|
||||
"shape":"NullableInteger",
|
||||
"documentation":"<p><b>Grey.</b> AWS Elastic Beanstalk and the health agent are reporting an insufficient amount of data on an instance.</p>"
|
||||
"documentation":"<p> <b>Grey.</b> AWS Elastic Beanstalk and the health agent are reporting an insufficient amount of data on an instance.</p>"
|
||||
},
|
||||
"Pending":{
|
||||
"shape":"NullableInteger",
|
||||
"documentation":"<p><b>Grey.</b> An operation is in progress on an instance within the command timeout.</p>"
|
||||
"documentation":"<p> <b>Grey.</b> An operation is in progress on an instance within the command timeout.</p>"
|
||||
},
|
||||
"Ok":{
|
||||
"shape":"NullableInteger",
|
||||
"documentation":"<p><b>Green.</b> An instance is passing health checks and the health agent is not reporting any problems.</p>"
|
||||
"documentation":"<p> <b>Green.</b> An instance is passing health checks and the health agent is not reporting any problems.</p>"
|
||||
},
|
||||
"Info":{
|
||||
"shape":"NullableInteger",
|
||||
"documentation":"<p><b>Green.</b> An operation is in progress on an instance.</p>"
|
||||
"documentation":"<p> <b>Green.</b> An operation is in progress on an instance.</p>"
|
||||
},
|
||||
"Warning":{
|
||||
"shape":"NullableInteger",
|
||||
"documentation":"<p><b>Yellow.</b> The health agent is reporting a moderate number of request failures or other issues for an instance or environment.</p>"
|
||||
"documentation":"<p> <b>Yellow.</b> The health agent is reporting a moderate number of request failures or other issues for an instance or environment.</p>"
|
||||
},
|
||||
"Degraded":{
|
||||
"shape":"NullableInteger",
|
||||
"documentation":"<p><b>Red.</b> The health agent is reporting a high number of request failures or other issues for an instance or environment.</p>"
|
||||
"documentation":"<p> <b>Red.</b> The health agent is reporting a high number of request failures or other issues for an instance or environment.</p>"
|
||||
},
|
||||
"Severe":{
|
||||
"shape":"NullableInteger",
|
||||
"documentation":"<p><b>Red.</b> The health agent is reporting a very high number of request failures or other issues for an instance or environment.</p>"
|
||||
"documentation":"<p> <b>Red.</b> The health agent is reporting a very high number of request failures or other issues for an instance or environment.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents summary information about the health of an instance. For more information, see <a href=\"http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html\">Health Colors and Statuses</a>.</p>"
|
||||
|
|
@ -2197,14 +2211,14 @@
|
|||
"members":{
|
||||
"SolutionStacks":{
|
||||
"shape":"AvailableSolutionStackNamesList",
|
||||
"documentation":"<p> A list of available solution stacks. </p>"
|
||||
"documentation":"<p>A list of available solution stacks.</p>"
|
||||
},
|
||||
"SolutionStackDetails":{
|
||||
"shape":"AvailableSolutionStackDetailsList",
|
||||
"documentation":"<p> A list of available solution stacks and their <a>SolutionStackDescription</a>. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A list of available AWS Elastic Beanstalk solution stacks. </p>"
|
||||
"documentation":"<p>A list of available AWS Elastic Beanstalk solution stacks.</p>"
|
||||
},
|
||||
"Listener":{
|
||||
"type":"structure",
|
||||
|
|
@ -2384,32 +2398,32 @@
|
|||
"members":{
|
||||
"Pattern":{
|
||||
"shape":"RegexPattern",
|
||||
"documentation":"<p> The regular expression pattern that a string configuration option value with this restriction must match. </p>"
|
||||
"documentation":"<p>The regular expression pattern that a string configuration option value with this restriction must match.</p>"
|
||||
},
|
||||
"Label":{
|
||||
"shape":"RegexLabel",
|
||||
"documentation":"<p> A unique name representing this regular expression. </p>"
|
||||
"documentation":"<p>A unique name representing this regular expression.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> A regular expression representing a restriction on a string configuration option value. </p>"
|
||||
"documentation":"<p>A regular expression representing a restriction on a string configuration option value.</p>"
|
||||
},
|
||||
"OptionSpecification":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ResourceName":{
|
||||
"shape":"ResourceName",
|
||||
"documentation":"<p> A unique resource name for a time-based scaling configuration option. </p>"
|
||||
"documentation":"<p>A unique resource name for a time-based scaling configuration option.</p>"
|
||||
},
|
||||
"Namespace":{
|
||||
"shape":"OptionNamespace",
|
||||
"documentation":"<p> A unique namespace identifying the option's associated AWS resource. </p>"
|
||||
"documentation":"<p>A unique namespace identifying the option's associated AWS resource.</p>"
|
||||
},
|
||||
"OptionName":{
|
||||
"shape":"ConfigurationOptionName",
|
||||
"documentation":"<p> The name of the configuration option. </p>"
|
||||
"documentation":"<p>The name of the configuration option.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> A specification identifying an individual configuration option. </p>"
|
||||
"documentation":"<p>A specification identifying an individual configuration option.</p>"
|
||||
},
|
||||
"OptionsSpecifierList":{
|
||||
"type":"list",
|
||||
|
|
@ -2438,11 +2452,11 @@
|
|||
"members":{
|
||||
"EnvironmentId":{
|
||||
"shape":"EnvironmentId",
|
||||
"documentation":"<p> The ID of the environment to rebuild. </p> <p> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>"
|
||||
"documentation":"<p>The ID of the environment to rebuild.</p> <p> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>"
|
||||
},
|
||||
"EnvironmentName":{
|
||||
"shape":"EnvironmentName",
|
||||
"documentation":"<p> The name of the environment to rebuild. </p> <p> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>"
|
||||
"documentation":"<p>The name of the environment to rebuild.</p> <p> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
|
|
@ -2482,11 +2496,11 @@
|
|||
"members":{
|
||||
"EnvironmentId":{
|
||||
"shape":"EnvironmentId",
|
||||
"documentation":"<p> The ID of the environment to restart the server for. </p> <p> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>"
|
||||
"documentation":"<p>The ID of the environment to restart the server for.</p> <p> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>"
|
||||
},
|
||||
"EnvironmentName":{
|
||||
"shape":"EnvironmentName",
|
||||
"documentation":"<p> The name of the environment to restart the server for. </p> <p> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>"
|
||||
"documentation":"<p>The name of the environment to restart the server for.</p> <p> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
|
|
@ -2505,7 +2519,7 @@
|
|||
},
|
||||
"InfoType":{
|
||||
"shape":"EnvironmentInfoType",
|
||||
"documentation":"<p> The type of information to retrieve. </p>"
|
||||
"documentation":"<p>The type of information to retrieve.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Request to download logs retrieved with <a>RequestEnvironmentInfo</a>.</p>"
|
||||
|
|
@ -2612,14 +2626,14 @@
|
|||
"members":{
|
||||
"SolutionStackName":{
|
||||
"shape":"SolutionStackName",
|
||||
"documentation":"<p> The name of the solution stack. </p>"
|
||||
"documentation":"<p>The name of the solution stack.</p>"
|
||||
},
|
||||
"PermittedFileTypes":{
|
||||
"shape":"SolutionStackFileTypeList",
|
||||
"documentation":"<p> The permitted file types allowed for a solution stack. </p>"
|
||||
"documentation":"<p>The permitted file types allowed for a solution stack.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Describes the solution stack. </p>"
|
||||
"documentation":"<p>Describes the solution stack.</p>"
|
||||
},
|
||||
"SolutionStackFileTypeList":{
|
||||
"type":"list",
|
||||
|
|
@ -2629,6 +2643,19 @@
|
|||
"type":"string",
|
||||
"max":100
|
||||
},
|
||||
"SourceBuildInformation":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"SourceType",
|
||||
"SourceRepository",
|
||||
"SourceLocation"
|
||||
],
|
||||
"members":{
|
||||
"SourceType":{"shape":"SourceType"},
|
||||
"SourceRepository":{"shape":"SourceRepository"},
|
||||
"SourceLocation":{"shape":"SourceLocation"}
|
||||
}
|
||||
},
|
||||
"SourceBundleDeletionException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2655,6 +2682,20 @@
|
|||
},
|
||||
"documentation":"<p>A specification for an environment configuration</p>"
|
||||
},
|
||||
"SourceLocation":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":3,
|
||||
"pattern":".+/.+"
|
||||
},
|
||||
"SourceRepository":{
|
||||
"type":"string",
|
||||
"enum":["CodeCommit"]
|
||||
},
|
||||
"SourceType":{
|
||||
"type":"string",
|
||||
"enum":["Git"]
|
||||
},
|
||||
"StatusCodes":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2683,19 +2724,19 @@
|
|||
"members":{
|
||||
"SourceEnvironmentId":{
|
||||
"shape":"EnvironmentId",
|
||||
"documentation":"<p> The ID of the source environment. </p> <p> Condition: You must specify at least the <code>SourceEnvironmentID</code> or the <code>SourceEnvironmentName</code>. You may also specify both. If you specify the <code>SourceEnvironmentId</code>, you must specify the <code>DestinationEnvironmentId</code>. </p>"
|
||||
"documentation":"<p>The ID of the source environment.</p> <p> Condition: You must specify at least the <code>SourceEnvironmentID</code> or the <code>SourceEnvironmentName</code>. You may also specify both. If you specify the <code>SourceEnvironmentId</code>, you must specify the <code>DestinationEnvironmentId</code>. </p>"
|
||||
},
|
||||
"SourceEnvironmentName":{
|
||||
"shape":"EnvironmentName",
|
||||
"documentation":"<p> The name of the source environment. </p> <p> Condition: You must specify at least the <code>SourceEnvironmentID</code> or the <code>SourceEnvironmentName</code>. You may also specify both. If you specify the <code>SourceEnvironmentName</code>, you must specify the <code>DestinationEnvironmentName</code>. </p>"
|
||||
"documentation":"<p>The name of the source environment.</p> <p> Condition: You must specify at least the <code>SourceEnvironmentID</code> or the <code>SourceEnvironmentName</code>. You may also specify both. If you specify the <code>SourceEnvironmentName</code>, you must specify the <code>DestinationEnvironmentName</code>. </p>"
|
||||
},
|
||||
"DestinationEnvironmentId":{
|
||||
"shape":"EnvironmentId",
|
||||
"documentation":"<p> The ID of the destination environment. </p> <p> Condition: You must specify at least the <code>DestinationEnvironmentID</code> or the <code>DestinationEnvironmentName</code>. You may also specify both. You must specify the <code>SourceEnvironmentId</code> with the <code>DestinationEnvironmentId</code>. </p>"
|
||||
"documentation":"<p>The ID of the destination environment.</p> <p> Condition: You must specify at least the <code>DestinationEnvironmentID</code> or the <code>DestinationEnvironmentName</code>. You may also specify both. You must specify the <code>SourceEnvironmentId</code> with the <code>DestinationEnvironmentId</code>. </p>"
|
||||
},
|
||||
"DestinationEnvironmentName":{
|
||||
"shape":"EnvironmentName",
|
||||
"documentation":"<p> The name of the destination environment. </p> <p> Condition: You must specify at least the <code>DestinationEnvironmentID</code> or the <code>DestinationEnvironmentName</code>. You may also specify both. You must specify the <code>SourceEnvironmentName</code> with the <code>DestinationEnvironmentName</code>. </p>"
|
||||
"documentation":"<p>The name of the destination environment.</p> <p> Condition: You must specify at least the <code>DestinationEnvironmentID</code> or the <code>DestinationEnvironmentName</code>. You may also specify both. You must specify the <code>SourceEnvironmentName</code> with the <code>DestinationEnvironmentName</code>. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Swaps the CNAMEs of two environments.</p>"
|
||||
|
|
@ -2753,7 +2794,7 @@
|
|||
},
|
||||
"TerminateResources":{
|
||||
"shape":"TerminateEnvironmentResources",
|
||||
"documentation":"<p> Indicates whether the associated AWS resources should shut down when the environment is terminated: </p> <ul> <li> <code>true</code>: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. </li> <li> <code>false</code>: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate. </li> </ul> <p> For more information, see the <a href=\"http://docs.aws.amazon.com/elasticbeanstalk/latest/ug/\"> AWS Elastic Beanstalk User Guide. </a> </p> <p> Default: <code>true</code> </p> <p> Valid Values: <code>true</code> | <code>false</code> </p>"
|
||||
"documentation":"<p>Indicates whether the associated AWS resources should shut down when the environment is terminated:</p> <ul> <li> <p> <code>true</code>: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.</p> </li> <li> <p> <code>false</code>: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.</p> </li> </ul> <p> For more information, see the <a href=\"http://docs.aws.amazon.com/elasticbeanstalk/latest/ug/\"> AWS Elastic Beanstalk User Guide. </a> </p> <p> Default: <code>true</code> </p> <p> Valid Values: <code>true</code> | <code>false</code> </p>"
|
||||
},
|
||||
"ForceTerminate":{
|
||||
"shape":"ForceTerminate",
|
||||
|
|
@ -2846,7 +2887,7 @@
|
|||
},
|
||||
"Description":{
|
||||
"shape":"Description",
|
||||
"documentation":"<p> A new description for the application. </p> <p>Default: If not specified, AWS Elastic Beanstalk does not update the description. </p>"
|
||||
"documentation":"<p>A new description for the application.</p> <p>Default: If not specified, AWS Elastic Beanstalk does not update the description.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Request to update an application.</p>"
|
||||
|
|
@ -2860,7 +2901,7 @@
|
|||
"members":{
|
||||
"ApplicationName":{
|
||||
"shape":"ApplicationName",
|
||||
"documentation":"<p> The name of the application associated with this version. </p> <p> If no application is found with this name, <code>UpdateApplication</code> returns an <code>InvalidParameterValue</code> error. </p>"
|
||||
"documentation":"<p>The name of the application associated with this version.</p> <p> If no application is found with this name, <code>UpdateApplication</code> returns an <code>InvalidParameterValue</code> error. </p>"
|
||||
},
|
||||
"VersionLabel":{
|
||||
"shape":"VersionLabel",
|
||||
|
|
@ -2894,11 +2935,11 @@
|
|||
},
|
||||
"OptionSettings":{
|
||||
"shape":"ConfigurationOptionSettingsList",
|
||||
"documentation":"<p> A list of configuration option settings to update with the new specified option value. </p>"
|
||||
"documentation":"<p>A list of configuration option settings to update with the new specified option value.</p>"
|
||||
},
|
||||
"OptionsToRemove":{
|
||||
"shape":"OptionsSpecifierList",
|
||||
"documentation":"<p> A list of configuration options to remove from the configuration set. </p> <p> Constraint: You can remove only <code>UserDefined</code> configuration options. </p>"
|
||||
"documentation":"<p>A list of configuration options to remove from the configuration set.</p> <p> Constraint: You can remove only <code>UserDefined</code> configuration options. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The result message containing the options for the specified solution stack.</p>"
|
||||
|
|
@ -2925,11 +2966,11 @@
|
|||
},
|
||||
"Description":{
|
||||
"shape":"Description",
|
||||
"documentation":"<p>If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment. </p>"
|
||||
"documentation":"<p>If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.</p>"
|
||||
},
|
||||
"Tier":{
|
||||
"shape":"EnvironmentTier",
|
||||
"documentation":"<p>This specifies the tier to use to update the environment. </p> <p>Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns <code>InvalidParameterValue</code> error. </p>"
|
||||
"documentation":"<p>This specifies the tier to use to update the environment.</p> <p>Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns <code>InvalidParameterValue</code> error. </p>"
|
||||
},
|
||||
"VersionLabel":{
|
||||
"shape":"VersionLabel",
|
||||
|
|
@ -2941,15 +2982,15 @@
|
|||
},
|
||||
"SolutionStackName":{
|
||||
"shape":"SolutionStackName",
|
||||
"documentation":"<p>This specifies the platform version that the environment will run after the environment is updated. </p>"
|
||||
"documentation":"<p>This specifies the platform version that the environment will run after the environment is updated.</p>"
|
||||
},
|
||||
"OptionSettings":{
|
||||
"shape":"ConfigurationOptionSettingsList",
|
||||
"documentation":"<p>If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value. </p>"
|
||||
"documentation":"<p>If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.</p>"
|
||||
},
|
||||
"OptionsToRemove":{
|
||||
"shape":"OptionsSpecifierList",
|
||||
"documentation":"<p>A list of custom user-defined configuration options to remove from the configuration set for this environment. </p>"
|
||||
"documentation":"<p>A list of custom user-defined configuration options to remove from the configuration set for this environment.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Request to update an environment.</p>"
|
||||
|
|
@ -2964,33 +3005,33 @@
|
|||
"members":{
|
||||
"ApplicationName":{
|
||||
"shape":"ApplicationName",
|
||||
"documentation":"<p> The name of the application that the configuration template or environment belongs to. </p>"
|
||||
"documentation":"<p>The name of the application that the configuration template or environment belongs to.</p>"
|
||||
},
|
||||
"TemplateName":{
|
||||
"shape":"ConfigurationTemplateName",
|
||||
"documentation":"<p> The name of the configuration template to validate the settings against. </p> <p> Condition: You cannot specify both this and an environment name. </p>"
|
||||
"documentation":"<p>The name of the configuration template to validate the settings against.</p> <p>Condition: You cannot specify both this and an environment name.</p>"
|
||||
},
|
||||
"EnvironmentName":{
|
||||
"shape":"EnvironmentName",
|
||||
"documentation":"<p> The name of the environment to validate the settings against. </p> <p> Condition: You cannot specify both this and a configuration template name. </p>"
|
||||
"documentation":"<p>The name of the environment to validate the settings against.</p> <p>Condition: You cannot specify both this and a configuration template name.</p>"
|
||||
},
|
||||
"OptionSettings":{
|
||||
"shape":"ConfigurationOptionSettingsList",
|
||||
"documentation":"<p> A list of the options and desired values to evaluate. </p>"
|
||||
"documentation":"<p>A list of the options and desired values to evaluate.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A list of validation messages for a specified configuration template. </p>"
|
||||
"documentation":"<p>A list of validation messages for a specified configuration template.</p>"
|
||||
},
|
||||
"ValidationMessage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{
|
||||
"shape":"ValidationMessageString",
|
||||
"documentation":"<p> A message describing the error or warning. </p>"
|
||||
"documentation":"<p>A message describing the error or warning.</p>"
|
||||
},
|
||||
"Severity":{
|
||||
"shape":"ValidationSeverity",
|
||||
"documentation":"<p> An indication of the severity of this message: </p> <ul> <li> <code>error</code>: This message indicates that this is not a valid setting for an option. </li> <li> <code>warning</code>: This message is providing information you should take into account. </li> </ul>"
|
||||
"documentation":"<p>An indication of the severity of this message:</p> <ul> <li> <p> <code>error</code>: This message indicates that this is not a valid setting for an option.</p> </li> <li> <p> <code>warning</code>: This message is providing information you should take into account.</p> </li> </ul>"
|
||||
},
|
||||
"Namespace":{
|
||||
"shape":"OptionNamespace",
|
||||
|
|
@ -3001,7 +3042,7 @@
|
|||
"documentation":"<p/>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> An error or warning for a desired configuration option value. </p>"
|
||||
"documentation":"<p>An error or warning for a desired configuration option value.</p>"
|
||||
},
|
||||
"ValidationMessageString":{"type":"string"},
|
||||
"ValidationMessagesList":{
|
||||
|
|
@ -3029,5 +3070,5 @@
|
|||
"member":{"shape":"VersionLabel"}
|
||||
}
|
||||
},
|
||||
"documentation":"<fullname>AWS Elastic Beanstalk</fullname> <p>AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.</p> <p>For more information about this product, go to the <a href=\"http://aws.amazon.com/elasticbeanstalk/\">AWS Elastic Beanstalk</a> details page. The location of the latest AWS Elastic Beanstalk WSDL is <a href=\"http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl\">http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl</a>. 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 <a href=\"https://aws.amazon.com/tools/\">Tools for Amazon Web Services</a>.</p> <p><b>Endpoints</b></p> <p>For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region\">Regions and Endpoints</a> in the <i>Amazon Web Services Glossary</i>.</p>"
|
||||
"documentation":"<fullname>AWS Elastic Beanstalk</fullname> <p>AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.</p> <p>For more information about this product, go to the <a href=\"http://aws.amazon.com/elasticbeanstalk/\">AWS Elastic Beanstalk</a> details page. The location of the latest AWS Elastic Beanstalk WSDL is <a href=\"http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl\">http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl</a>. 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 <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services</a>.</p> <p> <b>Endpoints</b> </p> <p>For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region\">Regions and Endpoints</a> in the <i>Amazon Web Services Glossary</i>.</p>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -16,12 +16,12 @@
|
|||
]
|
||||
},
|
||||
"regions": {
|
||||
"aws-global": {
|
||||
"description": "AWS partition-global endpoint"
|
||||
},
|
||||
"us-east-1": {
|
||||
"description": "US East (N. Virginia)"
|
||||
},
|
||||
"us-east-2": {
|
||||
"description": "US East (Ohio)"
|
||||
},
|
||||
"us-west-1": {
|
||||
"description": "US West (N. California)"
|
||||
},
|
||||
|
|
@ -35,7 +35,7 @@
|
|||
"description": "Asia Pacific (Seoul)"
|
||||
},
|
||||
"ap-south-1": {
|
||||
"description": "Asia Pacific (Bombay)"
|
||||
"description": "Asia Pacific (Mumbai)"
|
||||
},
|
||||
"ap-southeast-1": {
|
||||
"description": "Asia Pacific (Singapore)"
|
||||
|
|
@ -57,6 +57,7 @@
|
|||
"acm": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"eu-west-1": {},
|
||||
|
|
@ -72,10 +73,13 @@
|
|||
"apigateway": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-2": {},
|
||||
"eu-west-1": {},
|
||||
"ap-northeast-1": {},
|
||||
"ap-northeast-2": {},
|
||||
"ap-southeast-1": {},
|
||||
"ap-southeast-2": {},
|
||||
"eu-central-1": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -92,7 +96,13 @@
|
|||
},
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-southeast-1": {},
|
||||
"ap-southeast-2": {},
|
||||
"ap-northeast-1": {},
|
||||
"eu-central-1": {},
|
||||
"eu-west-1": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -111,8 +121,10 @@
|
|||
},
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-south-1": {},
|
||||
"ap-northeast-1": {},
|
||||
"ap-northeast-2": {},
|
||||
"ap-southeast-1": {},
|
||||
|
|
@ -125,6 +137,7 @@
|
|||
"cloudformation": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -156,6 +169,8 @@
|
|||
"cloudhsm": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
"ap-southeast-1": {},
|
||||
|
|
@ -181,6 +196,7 @@
|
|||
"cloudtrail": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -195,12 +211,14 @@
|
|||
},
|
||||
"codecommit": {
|
||||
"endpoints": {
|
||||
"us-east-1": {}
|
||||
"us-east-1": {},
|
||||
"us-east-2": {}
|
||||
}
|
||||
},
|
||||
"codedeploy": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -216,33 +234,44 @@
|
|||
"codepipeline": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-2": {}
|
||||
}
|
||||
},
|
||||
"cognito-identity": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-west-2": {},
|
||||
"eu-west-1": {},
|
||||
"ap-northeast-1": {}
|
||||
"eu-central-1": {},
|
||||
"ap-northeast-1": {},
|
||||
"ap-northeast-2": {}
|
||||
}
|
||||
},
|
||||
"cognito-idp": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-west-2": {},
|
||||
"eu-west-1": {},
|
||||
"ap-northeast-1": {}
|
||||
"eu-central-1": {},
|
||||
"ap-northeast-1": {},
|
||||
"ap-northeast-2": {}
|
||||
}
|
||||
},
|
||||
"cognito-sync": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-west-2": {},
|
||||
"eu-west-1": {},
|
||||
"ap-northeast-1": {}
|
||||
"eu-central-1": {},
|
||||
"ap-northeast-1": {},
|
||||
"ap-northeast-2": {}
|
||||
}
|
||||
},
|
||||
"config": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -278,6 +307,9 @@
|
|||
"us-east-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
"ap-northeast-2": {},
|
||||
"ap-southeast-1": {},
|
||||
"ap-southeast-2": {},
|
||||
"eu-west-1": {},
|
||||
"eu-central-1": {}
|
||||
}
|
||||
|
|
@ -290,6 +322,7 @@
|
|||
"directconnect": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -310,11 +343,15 @@
|
|||
"dms": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
"ap-northeast-2": {},
|
||||
"ap-south-1": {},
|
||||
"ap-southeast-1": {},
|
||||
"ap-southeast-2": {},
|
||||
"sa-east-1": {},
|
||||
"eu-west-1": {},
|
||||
"eu-central-1": {}
|
||||
}
|
||||
|
|
@ -326,7 +363,8 @@
|
|||
"ap-northeast-1": {},
|
||||
"ap-southeast-1": {},
|
||||
"ap-southeast-2": {},
|
||||
"eu-west-1": {}
|
||||
"eu-west-1": {},
|
||||
"eu-central-1": {}
|
||||
}
|
||||
},
|
||||
"dynamodb": {
|
||||
|
|
@ -338,6 +376,7 @@
|
|||
},
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -368,6 +407,7 @@
|
|||
},
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -383,6 +423,7 @@
|
|||
"ecs": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -395,13 +436,20 @@
|
|||
"ecr": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"eu-west-1": {}
|
||||
"ap-northeast-1": {},
|
||||
"ap-southeast-1": {},
|
||||
"ap-southeast-2": {},
|
||||
"eu-west-1": {},
|
||||
"eu-central-1": {}
|
||||
}
|
||||
},
|
||||
"elasticache": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -417,6 +465,7 @@
|
|||
"elasticbeanstalk": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -431,7 +480,9 @@
|
|||
},
|
||||
"elasticfilesystem": {
|
||||
"endpoints": {
|
||||
"us-west-2": {}
|
||||
"us-east-1": {},
|
||||
"us-west-2": {},
|
||||
"eu-west-1": {}
|
||||
}
|
||||
},
|
||||
"elasticloadbalancing": {
|
||||
|
|
@ -443,6 +494,7 @@
|
|||
},
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -467,6 +519,7 @@
|
|||
"us-east-1": {
|
||||
"sslCommonName": "{service}.{region}.{dnsSuffix}"
|
||||
},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -487,7 +540,9 @@
|
|||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
"ap-south-1": {},
|
||||
"ap-southeast-1": {},
|
||||
"ap-southeast-2": {},
|
||||
"eu-west-1": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -501,6 +556,7 @@
|
|||
"es": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"eu-west-1": {},
|
||||
|
|
@ -516,10 +572,12 @@
|
|||
"events": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"eu-west-1": {},
|
||||
"eu-central-1": {},
|
||||
"ap-south-1": {},
|
||||
"ap-southeast-1": {},
|
||||
"ap-southeast-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -551,6 +609,7 @@
|
|||
},
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -595,7 +654,10 @@
|
|||
"us-west-2": {},
|
||||
"us-east-1": {},
|
||||
"eu-west-1": {},
|
||||
"ap-northeast-1": {}
|
||||
"ap-northeast-1": {},
|
||||
"ap-northeast-2": {},
|
||||
"ap-south-1": {},
|
||||
"ap-southeast-2": {}
|
||||
}
|
||||
},
|
||||
"iot": {
|
||||
|
|
@ -608,7 +670,9 @@
|
|||
"us-east-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
"ap-northeast-2": {},
|
||||
"ap-southeast-1": {},
|
||||
"ap-southeast-2": {},
|
||||
"eu-west-1": {},
|
||||
"eu-central-1": {}
|
||||
}
|
||||
|
|
@ -616,6 +680,7 @@
|
|||
"kinesis": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -628,9 +693,17 @@
|
|||
"sa-east-1": {}
|
||||
}
|
||||
},
|
||||
"kinesisanalytics": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-west-2": {},
|
||||
"eu-west-1": {}
|
||||
}
|
||||
},
|
||||
"kms": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -646,8 +719,12 @@
|
|||
"lambda": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
"ap-northeast-2": {},
|
||||
"ap-southeast-1": {},
|
||||
"ap-southeast-2": {},
|
||||
"eu-west-1": {},
|
||||
"eu-central-1": {}
|
||||
}
|
||||
|
|
@ -655,6 +732,7 @@
|
|||
"logs": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -675,7 +753,8 @@
|
|||
},
|
||||
"marketplacecommerceanalytics": {
|
||||
"endpoints": {
|
||||
"us-east-1": {}
|
||||
"us-east-1": {},
|
||||
"us-east-2": {}
|
||||
}
|
||||
},
|
||||
"metering.marketplace": {
|
||||
|
|
@ -698,6 +777,7 @@
|
|||
},
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -720,10 +800,12 @@
|
|||
"us-east-1": {
|
||||
"sslCommonName": "{service}.{dnsSuffix}"
|
||||
},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
"ap-northeast-2": {},
|
||||
"ap-south-1": {},
|
||||
"ap-southeast-1": {},
|
||||
"ap-southeast-2": {},
|
||||
"sa-east-1": {},
|
||||
|
|
@ -734,6 +816,7 @@
|
|||
"redshift": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -771,57 +854,82 @@
|
|||
"https"
|
||||
],
|
||||
"signatureVersions": [
|
||||
"s3",
|
||||
"s3v4"
|
||||
]
|
||||
},
|
||||
"endpoints": {
|
||||
"us-east-1": {
|
||||
"hostname": "s3.amazonaws.com"
|
||||
"hostname": "s3.amazonaws.com",
|
||||
"signatureVersions": [
|
||||
"s3",
|
||||
"s3v4"
|
||||
]
|
||||
},
|
||||
"us-east-2": {},
|
||||
"s3-external-1": {
|
||||
"credentialScope": {
|
||||
"region": "us-east-1"
|
||||
},
|
||||
"hostname": "s3-external-1.amazonaws.com"
|
||||
"hostname": "s3-external-1.amazonaws.com",
|
||||
"signatureVersions": [
|
||||
"s3",
|
||||
"s3v4"
|
||||
]
|
||||
},
|
||||
"us-west-1": {
|
||||
"hostname": "s3-us-west-1.amazonaws.com"
|
||||
"hostname": "s3-us-west-1.amazonaws.com",
|
||||
"signatureVersions": [
|
||||
"s3",
|
||||
"s3v4"
|
||||
]
|
||||
},
|
||||
"us-west-2": {
|
||||
"hostname": "s3-us-west-2.amazonaws.com"
|
||||
"hostname": "s3-us-west-2.amazonaws.com",
|
||||
"signatureVersions": [
|
||||
"s3",
|
||||
"s3v4"
|
||||
]
|
||||
},
|
||||
"ap-northeast-1": {
|
||||
"hostname": "s3-ap-northeast-1.amazonaws.com"
|
||||
},
|
||||
"ap-northeast-2": {
|
||||
"hostname": "s3-ap-northeast-1.amazonaws.com",
|
||||
"signatureVersions": [
|
||||
"s3",
|
||||
"s3v4"
|
||||
]
|
||||
},
|
||||
"ap-northeast-2": {},
|
||||
"ap-south-1": {
|
||||
"hostname": "s3-ap-south-1.amazonaws.com",
|
||||
"signatureVersions": [
|
||||
"s3v4"
|
||||
]
|
||||
"hostname": "s3-ap-south-1.amazonaws.com"
|
||||
},
|
||||
"ap-southeast-1": {
|
||||
"hostname": "s3-ap-southeast-1.amazonaws.com"
|
||||
},
|
||||
"ap-southeast-2": {
|
||||
"hostname": "s3-ap-southeast-2.amazonaws.com"
|
||||
},
|
||||
"sa-east-1": {
|
||||
"hostname": "s3-sa-east-1.amazonaws.com"
|
||||
},
|
||||
"eu-west-1": {
|
||||
"hostname": "s3-eu-west-1.amazonaws.com"
|
||||
},
|
||||
"eu-central-1": {
|
||||
"hostname": "s3-ap-southeast-1.amazonaws.com",
|
||||
"signatureVersions": [
|
||||
"s3",
|
||||
"s3v4"
|
||||
]
|
||||
}
|
||||
},
|
||||
"ap-southeast-2": {
|
||||
"hostname": "s3-ap-southeast-2.amazonaws.com",
|
||||
"signatureVersions": [
|
||||
"s3",
|
||||
"s3v4"
|
||||
]
|
||||
},
|
||||
"sa-east-1": {
|
||||
"hostname": "s3-sa-east-1.amazonaws.com",
|
||||
"signatureVersions": [
|
||||
"s3",
|
||||
"s3v4"
|
||||
]
|
||||
},
|
||||
"eu-west-1": {
|
||||
"hostname": "s3-eu-west-1.amazonaws.com",
|
||||
"signatureVersions": [
|
||||
"s3",
|
||||
"s3v4"
|
||||
]
|
||||
},
|
||||
"eu-central-1": {}
|
||||
}
|
||||
},
|
||||
"sdb": {
|
||||
|
|
@ -847,6 +955,30 @@
|
|||
"eu-west-1": {}
|
||||
}
|
||||
},
|
||||
"servicecatalog": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"eu-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
"ap-southeast-1": {},
|
||||
"ap-southeast-2": {},
|
||||
"eu-central-1": {}
|
||||
}
|
||||
},
|
||||
"snowball": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-south-1": {},
|
||||
"ap-southeast-2": {},
|
||||
"eu-central-1": {},
|
||||
"eu-west-1": {}
|
||||
}
|
||||
},
|
||||
"sns": {
|
||||
"defaults": {
|
||||
"protocols": [
|
||||
|
|
@ -856,6 +988,7 @@
|
|||
},
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -880,6 +1013,7 @@
|
|||
"us-east-1": {
|
||||
"sslCommonName": "queue.{dnsSuffix}"
|
||||
},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -900,6 +1034,7 @@
|
|||
"eu-central-1": {},
|
||||
"eu-west-1": {},
|
||||
"ap-northeast-1": {},
|
||||
"ap-northeast-2": {},
|
||||
"ap-southeast-1": {},
|
||||
"ap-southeast-2": {},
|
||||
"sa-east-1": {}
|
||||
|
|
@ -908,6 +1043,7 @@
|
|||
"storagegateway": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -930,6 +1066,7 @@
|
|||
},
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -952,6 +1089,7 @@
|
|||
"endpoints": {
|
||||
"aws-global": {},
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -976,6 +1114,7 @@
|
|||
"swf": {
|
||||
"endpoints": {
|
||||
"us-east-1": {},
|
||||
"us-east-2": {},
|
||||
"us-west-1": {},
|
||||
"us-west-2": {},
|
||||
"ap-northeast-1": {},
|
||||
|
|
@ -1027,9 +1166,6 @@
|
|||
]
|
||||
},
|
||||
"regions": {
|
||||
"aws-cn-global": {
|
||||
"description": "AWS China partition-global endpoint"
|
||||
},
|
||||
"cn-north-1": {
|
||||
"description": "China (Beijing)"
|
||||
}
|
||||
|
|
@ -1242,9 +1378,6 @@
|
|||
]
|
||||
},
|
||||
"regions": {
|
||||
"aws-us-gov-global": {
|
||||
"description": "AWS GovCloud (US) partition-global endpoint"
|
||||
},
|
||||
"us-gov-west-1": {
|
||||
"description": "AWS GovCloud (US)"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -4,12 +4,11 @@
|
|||
"apiVersion":"2015-10-01",
|
||||
"endpointPrefix":"gamelift",
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceFullName":"Amazon GameLift",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"GameLift",
|
||||
"protocol":"json"
|
||||
"targetPrefix":"GameLift"
|
||||
},
|
||||
"documentation":"<fullname>Amazon GameLift Service</fullname> <p>Welcome to the <i>Amazon GameLift API Reference</i>. 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.</p> <p>This reference describes the low-level service API for GameLift. You can call this API directly or use the <a href=\"https://aws.amazon.com/tools/#sdk\">AWS SDK</a> for your preferred language. The AWS SDK includes a set of high-level GameLift actions multiplayer game sessions. Alternatively, you can use the <a href=\"https://aws.amazon.com/cli/\">AWS command-line interface</a> (CLI) tool, which includes commands for GameLift. For administrative actions, you can also use the Amazon GameLift console. </p> <p><b>More Resources</b></p> <ul> <li> <a href=\"http://docs.aws.amazon.com/gamelift/latest/developerguide/\">Amazon GameLift Developer Guide</a>: Learn more about GameLift features and how to use them </li> <li> <a href=\"https://gamedev.amazon.com/forums/tutorials\">Lumberyard and GameLift Tutorials</a>: Get started fast with walkthroughs and sample projects</li> <li> <a href=\"https://aws.amazon.com/blogs/gamedev/\">GameDev Blog</a>: Stay up to date with new features and techniques</li> <li> <a href=\"https://gamedev.amazon.com/forums/spaces/123/gamelift-discussion.html\">GameDev Forums</a>: Connect with the GameDev community</li> </ul> <p><b>Manage Games and Players Through GameLift</b></p> <p>Call these actions from your game clients and/or services to create and manage multiplayer game sessions and player sessions.</p> <ul> <li> <b>Game sessions</b> <ul> <li><a>CreateGameSession</a></li> <li><a>DescribeGameSessions</a></li> <li><a>DescribeGameSessionDetails</a></li> <li><a>UpdateGameSession</a></li> <li><a>SearchGameSessions</a></li> </ul> </li> <li> <b>Player sessions</b> <ul> <li><a>CreatePlayerSession</a></li> <li><a>CreatePlayerSessions</a></li> <li><a>DescribePlayerSessions</a></li> </ul> </li> <li> <b>Other actions:</b> <ul> <li><a>GetGameSessionLogUrl</a></li> </ul> </li> </ul> <p><b>Set Up and Manage Game Servers</b></p> <p>Use these administrative actions to configure GameLift to host your game servers. When setting up GameLift, you'll 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.</p> <ul> <li> <b>Manage your builds:</b> <ul> <li><a>ListBuilds</a></li> <li><a>CreateBuild</a></li> <li><a>DescribeBuild</a></li> <li><a>UpdateBuild</a></li> <li><a>DeleteBuild</a></li> <li><a>RequestUploadCredentials</a></li> </ul> </li> <li> <b>Manage your fleets:</b> <ul> <li><a>ListFleets</a></li> <li><a>CreateFleet</a></li> <li>Describe fleets: <ul> <li><a>DescribeFleetAttributes</a></li> <li><a>DescribeFleetCapacity</a></li> <li><a>DescribeFleetPortSettings</a></li> <li><a>DescribeFleetUtilization</a></li> <li><a>DescribeEC2InstanceLimits</a></li> <li><a>DescribeFleetEvents</a></li> <li><a>DescribeRuntimeConfiguration</a></li> </ul> </li> <li>Update fleets: <ul> <li><a>UpdateFleetAttributes</a></li> <li><a>UpdateFleetCapacity</a></li> <li><a>UpdateFleetPortSettings</a></li> <li><a>UpdateRuntimeConfiguration</a></li> </ul> </li> <li><a>DeleteFleet</a></li> </ul> </li> <li> <b>Manage fleet aliases:</b> <ul> <li><a>ListAliases</a></li> <li><a>CreateAlias</a></li> <li><a>DescribeAlias</a></li> <li><a>UpdateAlias</a></li> <li><a>DeleteAlias</a></li> <li><a>ResolveAlias</a></li> </ul> </li> <li> <b>Manage autoscaling:</b> <ul> <li><a>PutScalingPolicy</a></li> <li><a>DescribeScalingPolicies</a></li> <li><a>DeleteScalingPolicy</a></li> </ul> </li> </ul> <p>To view changes to the API, see the GameLift <a href=\"http://docs.aws.amazon.com/gamelift/latest/developerguide/doc-history.html\">Document History</a> page.</p>",
|
||||
"operations":{
|
||||
"CreateAlias":{
|
||||
"name":"CreateAlias",
|
||||
|
|
@ -17,41 +16,14 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"CreateAliasInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"CreateAliasOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"CreateAliasInput"},
|
||||
"output":{"shape":"CreateAliasOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"ConflictException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"LimitExceededException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.</p>"
|
||||
}
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p>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.</p> <p>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 <a>UpdateAlias</a>.</p>"
|
||||
},
|
||||
|
|
@ -61,36 +33,13 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"CreateBuildInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"CreateBuildOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"CreateBuildInput"},
|
||||
"output":{"shape":"CreateBuildOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"ConflictException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
}
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>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 <code>INITIALIZED</code>, you can upload your game build.</p> <important> <p>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 <code>upload-build</code>, which creates a new build record and uploads the build files in one step. (See the <a href=\"http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html\">Amazon GameLift Developer Guide</a> help on packaging and uploading your build.) </p> </important> <p>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.</p>"
|
||||
},
|
||||
|
|
@ -100,48 +49,17 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"CreateFleetInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"CreateFleetOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"CreateFleetInput"},
|
||||
"output":{"shape":"CreateFleetOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"ConflictException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"LimitExceededException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
}
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"UnauthorizedException"}
|
||||
],
|
||||
"documentation":"<p>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 <a href=\"https://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instance Types</a> for more information), and deploy a specified game build to each instance. A newly created fleet passes through several statuses; once it reaches the <code>ACTIVE</code> status, it can begin hosting game sessions.</p> <p>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.</p> <p>If the <code>CreateFleet</code> call is successful, Amazon GameLift performs the following tasks:</p> <ul> <li>Creates a fleet record and sets the status to <code>NEW</code> (followed by other statuses as the fleet is activated).</li> <li>Sets the fleet's capacity to 1 \"desired\", which causes GameLift to start one new EC2 instance.</li> <li>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.</li> <li>Begins writing events to the fleet event log, which can be accessed in the GameLift console.</li> <li>Sets the fleet's status to <code>ACTIVE</code> once one server process in the fleet is ready to host a game session.</li> </ul> <p>After a fleet is created, use the following actions to change fleet properties and configuration:</p> <ul> <li> <a>UpdateFleetAttributes</a> -- Update fleet metadata, including name and description.</li> <li> <a>UpdateFleetCapacity</a> -- Increase or decrease the number of instances you want the fleet to maintain.</li> <li> <a>UpdateFleetPortSettings</a> -- Change the IP address and port ranges that allow access to incoming traffic.</li> <li> <a>UpdateRuntimeConfiguration</a> -- Change how server processes are launched in the fleet, including launch path, launch parameters, and the number of concurrent processes.</li> </ul>"
|
||||
"documentation":"<p>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 <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instance Types</a> for more information), and deploy a specified game build to each instance. A newly created fleet passes through several statuses; once it reaches the <code>ACTIVE</code> status, it can begin hosting game sessions.</p> <p>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.</p> <p>If the <code>CreateFleet</code> call is successful, Amazon GameLift performs the following tasks:</p> <ul> <li> <p>Creates a fleet record and sets the status to <code>NEW</code> (followed by other statuses as the fleet is activated).</p> </li> <li> <p>Sets the fleet's capacity to 1 \"desired\", which causes GameLift to start one new EC2 instance.</p> </li> <li> <p>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.</p> </li> <li> <p>Begins writing events to the fleet event log, which can be accessed in the GameLift console.</p> </li> <li> <p>Sets the fleet's status to <code>ACTIVE</code> once one server process in the fleet is ready to host a game session.</p> </li> </ul> <p>After a fleet is created, use the following actions to change fleet properties and configuration:</p> <ul> <li> <p> <a>UpdateFleetAttributes</a> -- Update fleet metadata, including name and description.</p> </li> <li> <p> <a>UpdateFleetCapacity</a> -- Increase or decrease the number of instances you want the fleet to maintain.</p> </li> <li> <p> <a>UpdateFleetPortSettings</a> -- Change the IP address and port ranges that allow access to incoming traffic.</p> </li> <li> <p> <a>UpdateRuntimeConfiguration</a> -- Change how server processes are launched in the fleet, including launch path, launch parameters, and the number of concurrent processes.</p> </li> </ul>"
|
||||
},
|
||||
"CreateGameSession":{
|
||||
"name":"CreateGameSession",
|
||||
|
|
@ -149,56 +67,19 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"CreateGameSessionInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"CreateGameSessionOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"CreateGameSessionInput"},
|
||||
"output":{"shape":"CreateGameSessionOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"ConflictException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidFleetStatusException",
|
||||
"exception":true,
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"TerminalRoutingStrategyException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The service is unable to resolve the routing for a particular alias because it has a terminal <a>RoutingStrategy</a> 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. </p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"FleetCapacityExceededException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The specified fleet has no available instances to fulfill a request to create a new game session. Such requests should only be retried once the fleet capacity has been increased. </p>"
|
||||
}
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InvalidFleetStatusException"},
|
||||
{"shape":"TerminalRoutingStrategyException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"FleetCapacityExceededException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"IdempotentParameterMismatchException"}
|
||||
],
|
||||
"documentation":"<p>Creates a multiplayer game session for players. This action creates a game session record and assigns the new session to an instance in the specified fleet, which initializes a new server process to host the game session. A fleet must be in an <code>ACTIVE</code> status before a game session can be created in it.</p> <p>To create a game session, specify either a fleet ID or an alias ID and indicate the maximum number of players the game session allows. You can also provide a name and a set of properties for your game (optional). If successful, a <a>GameSession</a> object is returned containing session properties, including an IP address. By default, newly created game sessions are set to accept adding any new players to the game session. Use <a>UpdateGameSession</a> to change the creation policy.</p>"
|
||||
},
|
||||
|
|
@ -208,51 +89,16 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"CreatePlayerSessionInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"CreatePlayerSessionOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"CreatePlayerSessionInput"},
|
||||
"output":{"shape":"CreatePlayerSessionOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidGameSessionStatusException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Clients should not retry such requests without resolving the conflict.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"GameSessionFullException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The game instance is currently full and cannot allow the requested player(s) to join. This exception occurs in response to a <a>CreatePlayerSession</a> request. </p>"
|
||||
},
|
||||
{
|
||||
"shape":"TerminalRoutingStrategyException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The service is unable to resolve the routing for a particular alias because it has a terminal <a>RoutingStrategy</a> 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. </p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
}
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InvalidGameSessionStatusException"},
|
||||
{"shape":"GameSessionFullException"},
|
||||
{"shape":"TerminalRoutingStrategyException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"NotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Adds a player to a game session and creates a player session record. A game session must be in an <code>ACTIVE</code> status, have a creation policy of <code>ALLOW_ALL</code>, and have an open player slot before players can be added to the session.</p> <p>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 <a>PlayerSession</a> object is returned. </p>"
|
||||
},
|
||||
|
|
@ -262,51 +108,16 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"CreatePlayerSessionsInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"CreatePlayerSessionsOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"CreatePlayerSessionsInput"},
|
||||
"output":{"shape":"CreatePlayerSessionsOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidGameSessionStatusException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Clients should not retry such requests without resolving the conflict.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"GameSessionFullException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The game instance is currently full and cannot allow the requested player(s) to join. This exception occurs in response to a <a>CreatePlayerSession</a> request. </p>"
|
||||
},
|
||||
{
|
||||
"shape":"TerminalRoutingStrategyException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The service is unable to resolve the routing for a particular alias because it has a terminal <a>RoutingStrategy</a> 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. </p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
}
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InvalidGameSessionStatusException"},
|
||||
{"shape":"GameSessionFullException"},
|
||||
{"shape":"TerminalRoutingStrategyException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"NotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Adds a group of players to a game session. Similar to <a>CreatePlayerSession</a>, 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 <code>ACTIVE</code> status, have a creation policy of <code>ALLOW_ALL</code>, and have an open player slot before players can be added to the session.</p> <p>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 <a>PlayerSession</a> objects is returned. </p>"
|
||||
},
|
||||
|
|
@ -316,32 +127,12 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"DeleteAliasInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"DeleteAliasInput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
}
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
|
|
@ -351,32 +142,12 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"DeleteBuildInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"DeleteBuildInput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
}
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>Deletes a build. This action permanently deletes the build record and any uploaded build files.</p> <p>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.</p>"
|
||||
},
|
||||
|
|
@ -386,37 +157,13 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"DeleteFleetInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"DeleteFleetInput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidFleetStatusException",
|
||||
"exception":true,
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
}
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidFleetStatusException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero. See <a>UpdateFleetCapacity</a>.</p> <p>This action removes the fleet's resources and the fleet record. Once a fleet is deleted, you can no longer use that fleet.</p>"
|
||||
},
|
||||
|
|
@ -426,34 +173,14 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"DeleteScalingPolicyInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"DeleteScalingPolicyInput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
}
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"NotFoundException"}
|
||||
],
|
||||
"documentation":"<p>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. </p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"DescribeAlias":{
|
||||
"name":"DescribeAlias",
|
||||
|
|
@ -461,36 +188,13 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"DescribeAliasInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"DescribeAliasOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"DescribeAliasInput"},
|
||||
"output":{"shape":"DescribeAliasOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
}
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves properties for a specified alias. To get the alias, specify an alias ID. If successful, an <a>Alias</a> object is returned.</p>"
|
||||
},
|
||||
|
|
@ -500,36 +204,13 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"DescribeBuildInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"DescribeBuildOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"DescribeBuildInput"},
|
||||
"output":{"shape":"DescribeBuildOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
}
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves properties for a build. To get a build record, specify a build ID. If successful, an object containing the build properties is returned.</p>"
|
||||
},
|
||||
|
|
@ -539,33 +220,14 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"DescribeEC2InstanceLimitsInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"DescribeEC2InstanceLimitsOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"DescribeEC2InstanceLimitsInput"},
|
||||
"output":{"shape":"DescribeEC2InstanceLimitsOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
}
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"UnauthorizedException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves the following information for the specified EC2 instance type:</p> <ul> <li>maximum number of instances allowed per AWS account (service limit)</li> <li>current usage level for the AWS account </li> </ul> <p>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).</p>"
|
||||
"documentation":"<p>Retrieves the following information for the specified EC2 instance type:</p> <ul> <li> <p>maximum number of instances allowed per AWS account (service limit)</p> </li> <li> <p>current usage level for the AWS account</p> </li> </ul> <p>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).</p>"
|
||||
},
|
||||
"DescribeFleetAttributes":{
|
||||
"name":"DescribeFleetAttributes",
|
||||
|
|
@ -573,36 +235,13 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"DescribeFleetAttributesInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"DescribeFleetAttributesOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"DescribeFleetAttributesInput"},
|
||||
"output":{"shape":"DescribeFleetAttributesOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
}
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"UnauthorizedException"}
|
||||
],
|
||||
"documentation":"<p>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 <a>FleetAttributes</a> 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. </p> <note> <p>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.</p> </note>"
|
||||
},
|
||||
|
|
@ -612,36 +251,13 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"DescribeFleetCapacityInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"DescribeFleetCapacityOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"DescribeFleetCapacityInput"},
|
||||
"output":{"shape":"DescribeFleetCapacityOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
}
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"UnauthorizedException"}
|
||||
],
|
||||
"documentation":"<p>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 <a>FleetCapacity</a> 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. </p> <note> <p>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.</p> </note>"
|
||||
},
|
||||
|
|
@ -651,36 +267,13 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"DescribeFleetEventsInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"DescribeFleetEventsOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"DescribeFleetEventsInput"},
|
||||
"output":{"shape":"DescribeFleetEventsOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
}
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
|
|
@ -690,36 +283,13 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"DescribeFleetPortSettingsInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"DescribeFleetPortSettingsOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"DescribeFleetPortSettingsInput"},
|
||||
"output":{"shape":"DescribeFleetPortSettingsOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
}
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"UnauthorizedException"}
|
||||
],
|
||||
"documentation":"<p>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 <a>IpPermission</a> objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.</p>"
|
||||
},
|
||||
|
|
@ -729,36 +299,13 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"DescribeFleetUtilizationInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"DescribeFleetUtilizationOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"DescribeFleetUtilizationInput"},
|
||||
"output":{"shape":"DescribeFleetUtilizationOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
}
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"UnauthorizedException"}
|
||||
],
|
||||
"documentation":"<p>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 <a>FleetUtilization</a> 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. </p> <note> <p>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.</p> </note>"
|
||||
},
|
||||
|
|
@ -768,41 +315,14 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"DescribeGameSessionDetailsInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"DescribeGameSessionDetailsOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"DescribeGameSessionDetailsInput"},
|
||||
"output":{"shape":"DescribeGameSessionDetailsOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"TerminalRoutingStrategyException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The service is unable to resolve the routing for a particular alias because it has a terminal <a>RoutingStrategy</a> 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. </p>"
|
||||
}
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"TerminalRoutingStrategyException"}
|
||||
],
|
||||
"documentation":"<p>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 <code>GameSessionId</code> to request details for a specific game session; (2) provide either a <code>FleetId</code> or an <code>AliasId</code> to request properties for all game sessions running on a fleet. </p> <p>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 <a>GameSessionDetail</a> object is returned for each session matching the request.</p>"
|
||||
},
|
||||
|
|
@ -812,43 +332,32 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"DescribeGameSessionsInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"DescribeGameSessionsOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"DescribeGameSessionsInput"},
|
||||
"output":{"shape":"DescribeGameSessionsOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"TerminalRoutingStrategyException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The service is unable to resolve the routing for a particular alias because it has a terminal <a>RoutingStrategy</a> 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. </p>"
|
||||
}
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"TerminalRoutingStrategyException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves properties for one or more game sessions. This action can be used in several ways: (1) provide a <code>GameSessionId</code> to request properties for a specific game session; (2) provide a <code>FleetId</code> or an <code>AliasId</code> to request properties for all game sessions running on a fleet. </p> <p>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 <a>GameSession</a> object is returned for each session matching the request.</p>"
|
||||
"documentation":"<p>Retrieves a set of one or more game sessions and properties. This action can be used in several ways: (1) provide a <code>GameSessionId</code> to request properties for a specific game session; (2) provide a <code>FleetId</code> or an <code>AliasId</code> to request properties for all game sessions running on a fleet. You can also use <a>SearchGameSessions</a>, 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 <a>DescribeGameSessionDetails</a>.</p> <p>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 <a>GameSession</a> object is returned for each session matching the request.</p>"
|
||||
},
|
||||
"DescribeInstances":{
|
||||
"name":"DescribeInstances",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeInstancesInput"},
|
||||
"output":{"shape":"DescribeInstancesOutput"},
|
||||
"errors":[
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves information about instances in a fleet.</p> <p>To get information on a specific instance, specify both a fleet ID and instance ID. To get information for 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 <a>Instance</a> object is returned for each result.</p>"
|
||||
},
|
||||
"DescribePlayerSessions":{
|
||||
"name":"DescribePlayerSessions",
|
||||
|
|
@ -856,36 +365,13 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"DescribePlayerSessionsInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"DescribePlayerSessionsOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"DescribePlayerSessionsInput"},
|
||||
"output":{"shape":"DescribePlayerSessionsOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
}
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"UnauthorizedException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a <code>PlayerSessionId</code> parameter to request properties for a specific player session; (2) provide a <code>GameSessionId</code> parameter to request properties for all player sessions in the specified game session; (3) provide a <code>PlayerId</code> parameter to request properties for all player sessions of a specified player. </p> <p>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 <a>PlayerSession</a> object is returned for each session matching the request.</p>"
|
||||
},
|
||||
|
|
@ -895,36 +381,13 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"DescribeRuntimeConfigurationInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"DescribeRuntimeConfigurationOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"DescribeRuntimeConfigurationInput"},
|
||||
"output":{"shape":"DescribeRuntimeConfigurationOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
}
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves the current runtime configuration for the specified fleet. The runtime configuration tells GameLift how to launch server processes on instances in the fleet.</p>"
|
||||
},
|
||||
|
|
@ -934,38 +397,15 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"DescribeScalingPoliciesInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"DescribeScalingPoliciesOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"DescribeScalingPoliciesInput"},
|
||||
"output":{"shape":"DescribeScalingPoliciesOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
}
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"NotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves all scaling policies applied to a fleet. </p> <p>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 <a>ScalingPolicy</a> objects is returned for the fleet.</p>"
|
||||
"documentation":"<p>Retrieves all scaling policies applied to a fleet.</p> <p>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 <a>ScalingPolicy</a> objects is returned for the fleet.</p>"
|
||||
},
|
||||
"GetGameSessionLogUrl":{
|
||||
"name":"GetGameSessionLogUrl",
|
||||
|
|
@ -973,36 +413,13 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"GetGameSessionLogUrlInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"GetGameSessionLogUrlOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"GetGameSessionLogUrlInput"},
|
||||
"output":{"shape":"GetGameSessionLogUrlOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
}
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>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.</p> <note> <p>See the <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_gamelift\">AWS Service Limits</a> page for maximum log file sizes. Log files that exceed this limit are not saved.</p> </note>"
|
||||
},
|
||||
|
|
@ -1012,33 +429,14 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"ListAliasesInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"ListAliasesOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"ListAliasesInput"},
|
||||
"output":{"shape":"ListAliasesOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
}
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>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. </p> <note> <p>Aliases are not listed in any particular order.</p> </note>"
|
||||
"documentation":"<p>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.</p> <note> <p>Aliases are not listed in any particular order.</p> </note>"
|
||||
},
|
||||
"ListBuilds":{
|
||||
"name":"ListBuilds",
|
||||
|
|
@ -1046,31 +444,12 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"ListBuildsInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"ListBuildsOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"ListBuildsInput"},
|
||||
"output":{"shape":"ListBuildsOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
}
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>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 <code>Status</code> parameter. Use the pagination parameters to retrieve results in a set of sequential pages. </p> <note> <p>Build records are not listed in any particular order.</p> </note>"
|
||||
},
|
||||
|
|
@ -1080,38 +459,15 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"ListFleetsInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"ListFleetsOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"ListFleetsInput"},
|
||||
"output":{"shape":"ListFleetsOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
}
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"UnauthorizedException"}
|
||||
],
|
||||
"documentation":"<p>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. </p> <note> <p>Fleet records are not listed in any particular order.</p> </note>"
|
||||
"documentation":"<p>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.</p> <note> <p>Fleet records are not listed in any particular order.</p> </note>"
|
||||
},
|
||||
"PutScalingPolicy":{
|
||||
"name":"PutScalingPolicy",
|
||||
|
|
@ -1119,38 +475,15 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"PutScalingPolicyInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"PutScalingPolicyOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"PutScalingPolicyInput"},
|
||||
"output":{"shape":"PutScalingPolicyOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
}
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"NotFoundException"}
|
||||
],
|
||||
"documentation":"<p>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.</p> <p>A scaling policy rule statement has the following structure:</p> <p>If <code>[MetricName]</code> is <code>[ComparisonOperator]</code> <code>[Threshold]</code> for <code>[EvaluationPeriods]</code> minutes, then <code>[ScalingAdjustmentType]</code> to/by <code>[ScalingAdjustment]</code>.</p> <p>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: </p> <p>If [IdleInstances] is [GreaterThanOrEqualToThreshold] [20] for [15] minutes, then [ChangeInCapacity] by [-10]. </p> <p>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 <a>DeleteScalingPolicy</a>.</p>"
|
||||
"documentation":"<p>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.</p> <p>A scaling policy rule statement has the following structure:</p> <p>If <code>[MetricName]</code> is <code>[ComparisonOperator]</code> <code>[Threshold]</code> for <code>[EvaluationPeriods]</code> minutes, then <code>[ScalingAdjustmentType]</code> to/by <code>[ScalingAdjustment]</code>.</p> <p>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:</p> <p>If [IdleInstances] is [GreaterThanOrEqualToThreshold] [20] for [15] minutes, then [ChangeInCapacity] by [-10].</p> <p>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 <a>DeleteScalingPolicy</a>.</p>"
|
||||
},
|
||||
"RequestUploadCredentials":{
|
||||
"name":"RequestUploadCredentials",
|
||||
|
|
@ -1158,38 +491,15 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"RequestUploadCredentialsInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"RequestUploadCredentialsOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"RequestUploadCredentialsInput"},
|
||||
"output":{"shape":"RequestUploadCredentialsOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
}
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>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.</p> <important> <p>Call this action only if you need credentials for a build created with <code><a>CreateBuild</a></code>. This is a rare situation; in most cases, builds are created using the CLI command <code>upload-build</code>, which creates a build record and also uploads build files. </p> </important> <p>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 <code>READY</code>. Once this happens, you must create a brand new build.</p>"
|
||||
"documentation":"<p>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.</p> <important> <p>Call this action only if you need credentials for a build created with <code> <a>CreateBuild</a> </code>. This is a rare situation; in most cases, builds are created using the CLI command <code>upload-build</code>, which creates a build record and also uploads build files. </p> </important> <p>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 <code>READY</code>. Once this happens, you must create a brand new build.</p>"
|
||||
},
|
||||
"ResolveAlias":{
|
||||
"name":"ResolveAlias",
|
||||
|
|
@ -1197,43 +507,16 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"ResolveAliasInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"ResolveAliasOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"ResolveAliasInput"},
|
||||
"output":{"shape":"ResolveAliasOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"TerminalRoutingStrategyException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The service is unable to resolve the routing for a particular alias because it has a terminal <a>RoutingStrategy</a> 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. </p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
}
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"TerminalRoutingStrategyException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves the fleet ID that a specified alias is currently pointing to. </p>"
|
||||
"documentation":"<p>Retrieves the fleet ID that a specified alias is currently pointing to.</p>"
|
||||
},
|
||||
"SearchGameSessions":{
|
||||
"name":"SearchGameSessions",
|
||||
|
|
@ -1241,43 +524,16 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"SearchGameSessionsInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"SearchGameSessionsOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"SearchGameSessionsInput"},
|
||||
"output":{"shape":"SearchGameSessionsOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"TerminalRoutingStrategyException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The service is unable to resolve the routing for a particular alias because it has a terminal <a>RoutingStrategy</a> 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. </p>"
|
||||
}
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"TerminalRoutingStrategyException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves a list of game sessions in a fleet that match a set of search criteria and sorts them in a specified order. Currently game session searches are limited to a single fleet. Search results include only game sessions that are in ACTIVE status.</p> <p>You can search or sort by the following game session attributes:</p> <ul> <li> <b>gameSessionId</b> -- ID value assigned to a game session. This unique value is returned in a <a>GameSession</a> object when a new game session is created. </li> <li> <b>gameSessionName</b> -- Name assigned to a game session. This value is set when requesting a new game session with <a>CreateGameSession</a> or updating with <a>UpdateGameSession</a>. Game session names do not need to be unique to a game session.</li> <li> <b>creationTimeMillis</b> -- Value indicating when a game session was created. It is expressed in Unix time as milliseconds.</li> <li> <b>playerSessionCount</b> -- Number of players currently connected to a game session. This value changes rapidly as players join the session or drop out.</li> <li> <b>maximumSessions</b> -- Maximum number of player sessions allowed for a game session. This value is set when requesting a new game session with <a>CreateGameSession</a> or updating with <a>UpdateGameSession</a>.</li> <li> <b>hasAvailablePlayerSessions</b> -- 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 <code>true</code> or <code>false</code>. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join. </li> </ul> <p>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 <a>GameSession</a> objects matching the request is returned.</p> <note> <p>Returned values for <code>playerSessionCount</code> and <code>hasAvailablePlayerSessions</code> 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. </p> </note>"
|
||||
"documentation":"<p>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 <a>DescribeGameSessions</a>. If you need to retrieve the protection policy for each game session, use <a>DescribeGameSessionDetails</a>.</p> <p>You can search or sort by the following game session attributes:</p> <ul> <li> <p> <b>gameSessionId</b> -- ID value assigned to a game session. This unique value is returned in a <a>GameSession</a> object when a new game session is created. </p> </li> <li> <p> <b>gameSessionName</b> -- Name assigned to a game session. This value is set when requesting a new game session with <a>CreateGameSession</a> or updating with <a>UpdateGameSession</a>. Game session names do not need to be unique to a game session.</p> </li> <li> <p> <b>creationTimeMillis</b> -- Value indicating when a game session was created. It is expressed in Unix time as milliseconds.</p> </li> <li> <p> <b>playerSessionCount</b> -- Number of players currently connected to a game session. This value changes rapidly as players join the session or drop out.</p> </li> <li> <p> <b>maximumSessions</b> -- Maximum number of player sessions allowed for a game session. This value is set when requesting a new game session with <a>CreateGameSession</a> or updating with <a>UpdateGameSession</a>.</p> </li> <li> <p> <b>hasAvailablePlayerSessions</b> -- 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 <code>true</code> or <code>false</code>. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join. </p> </li> </ul> <p>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 <a>GameSession</a> objects matching the request is returned.</p> <note> <p>Returned values for <code>playerSessionCount</code> and <code>hasAvailablePlayerSessions</code> 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. </p> </note>"
|
||||
},
|
||||
"UpdateAlias":{
|
||||
"name":"UpdateAlias",
|
||||
|
|
@ -1285,36 +541,13 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"UpdateAliasInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"UpdateAliasOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"UpdateAliasInput"},
|
||||
"output":{"shape":"UpdateAliasOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
}
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
|
|
@ -1324,38 +557,15 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"UpdateBuildInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"UpdateBuildOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"UpdateBuildInput"},
|
||||
"output":{"shape":"UpdateBuildOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
}
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>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. </p>"
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"UpdateFleetAttributes":{
|
||||
"name":"UpdateFleetAttributes",
|
||||
|
|
@ -1363,51 +573,16 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"UpdateFleetAttributesInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"UpdateFleetAttributesOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"UpdateFleetAttributesInput"},
|
||||
"output":{"shape":"UpdateFleetAttributesOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"ConflictException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidFleetStatusException",
|
||||
"exception":true,
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"LimitExceededException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
}
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"InvalidFleetStatusException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"UnauthorizedException"}
|
||||
],
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
|
|
@ -1417,51 +592,16 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"UpdateFleetCapacityInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"UpdateFleetCapacityOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"UpdateFleetCapacityInput"},
|
||||
"output":{"shape":"UpdateFleetCapacityOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"ConflictException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"LimitExceededException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidFleetStatusException",
|
||||
"exception":true,
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
}
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidFleetStatusException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"UnauthorizedException"}
|
||||
],
|
||||
"documentation":"<p>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 <a>DescribeEC2InstanceLimits</a> to get the maximum capacity based on the fleet's EC2 instance type.</p> <p>If you're using autoscaling (see <a>PutScalingPolicy</a>), 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 <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_gamelift\">service limits</a>.</p> <p>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 <a>DescribeFleetCapacity</a>. If the desired instance count is higher than the instance type's limit, the \"Limit Exceeded\" exception occurs.</p>"
|
||||
},
|
||||
|
|
@ -1471,51 +611,16 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"UpdateFleetPortSettingsInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"UpdateFleetPortSettingsOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"UpdateFleetPortSettingsInput"},
|
||||
"output":{"shape":"UpdateFleetPortSettingsOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"ConflictException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidFleetStatusException",
|
||||
"exception":true,
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"LimitExceededException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
}
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"InvalidFleetStatusException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"UnauthorizedException"}
|
||||
],
|
||||
"documentation":"<p>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 <code>InboundPermissionAuthorizations</code>, and permissions you want to remove in <code>InboundPermissionRevocations</code>. Permissions to be removed must match existing fleet permissions. If successful, the fleet ID for the updated fleet is returned.</p>"
|
||||
},
|
||||
|
|
@ -1525,46 +630,15 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"UpdateGameSessionInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"UpdateGameSessionOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"UpdateGameSessionInput"},
|
||||
"output":{"shape":"UpdateGameSessionOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"ConflictException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidGameSessionStatusException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Clients should not retry such requests without resolving the conflict.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
}
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InvalidGameSessionStatusException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>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 <a>GameSession</a> object is returned. </p>"
|
||||
},
|
||||
|
|
@ -1574,41 +648,14 @@
|
|||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{
|
||||
"shape":"UpdateRuntimeConfigurationInput",
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"UpdateRuntimeConfigurationOutput",
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"input":{"shape":"UpdateRuntimeConfigurationInput"},
|
||||
"output":{"shape":"UpdateRuntimeConfigurationOutput"},
|
||||
"errors":[
|
||||
{
|
||||
"shape":"UnauthorizedException",
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"NotFoundException",
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InternalServiceException",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidRequestException",
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
},
|
||||
{
|
||||
"shape":"InvalidFleetStatusException",
|
||||
"exception":true,
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"InvalidFleetStatusException"}
|
||||
],
|
||||
"documentation":"<p>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 <code>ACTIVE</code> status.</p> <p>To update runtime configuration, specify the fleet ID and provide a <code>RuntimeConfiguration</code> object with the updated collection of server process configurations.</p> <p>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.</p>"
|
||||
}
|
||||
|
|
@ -1622,7 +669,7 @@
|
|||
"documentation":"<p>Unique identifier for a fleet alias.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"FreeText",
|
||||
"shape":"NonBlankAndLengthConstraintString",
|
||||
"documentation":"<p>Descriptive label associated with an alias. Alias names do not need to be unique.</p>"
|
||||
},
|
||||
"Description":{
|
||||
|
|
@ -1649,6 +696,12 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"Alias"}
|
||||
},
|
||||
"ArnStringModel":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":1,
|
||||
"pattern":"[a-zA-Z0-9:/-]+"
|
||||
},
|
||||
"AwsCredentials":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1665,8 +718,8 @@
|
|||
"documentation":"<p>Token specific to a build ID.</p>"
|
||||
}
|
||||
},
|
||||
"sensitive":true,
|
||||
"documentation":"<p>AWS access credentials required to upload game build files to Amazon GameLift. These credentials are generated with <a>CreateBuild</a>, and are valid for a limited time. If they expire before you upload your game build, get a new set by calling <a>RequestUploadCredentials</a>.</p>"
|
||||
"documentation":"<p>AWS access credentials required to upload game build files to Amazon GameLift. These credentials are generated with <a>CreateBuild</a>, and are valid for a limited time. If they expire before you upload your game build, get a new set by calling <a>RequestUploadCredentials</a>.</p>",
|
||||
"sensitive":true
|
||||
},
|
||||
"Build":{
|
||||
"type":"structure",
|
||||
|
|
@ -1685,7 +738,7 @@
|
|||
},
|
||||
"Status":{
|
||||
"shape":"BuildStatus",
|
||||
"documentation":"<p>Current status of the build.</p> <p>Possible build statuses include the following:</p> <ul><li><b>INITIALIZED</b> – 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. </li><li><b>READY</b> – The game build has been successfully uploaded. You can now create new fleets for this build.</li><li><b>FAILED</b> – The game build upload failed. You cannot create new fleets for this build. </li></ul>"
|
||||
"documentation":"<p>Current status of the build.</p> <p>Possible build statuses include the following:</p> <ul> <li> <p> <b>INITIALIZED</b> – 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. </p> </li> <li> <p> <b>READY</b> – The game build has been successfully uploaded. You can now create new fleets for this build.</p> </li> <li> <p> <b>FAILED</b> – The game build upload failed. You cannot create new fleets for this build. </p> </li> </ul>"
|
||||
},
|
||||
"SizeOnDisk":{
|
||||
"shape":"PositiveLong",
|
||||
|
|
@ -1732,8 +785,8 @@
|
|||
"members":{
|
||||
"Message":{"shape":"NonEmptyString"}
|
||||
},
|
||||
"exception":true,
|
||||
"documentation":"<p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>"
|
||||
"documentation":"<p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"CreateAliasInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1743,7 +796,7 @@
|
|||
],
|
||||
"members":{
|
||||
"Name":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"shape":"NonBlankAndLengthConstraintString",
|
||||
"documentation":"<p>Descriptive label associated with an alias. Alias names do not need to be unique.</p>"
|
||||
},
|
||||
"Description":{
|
||||
|
|
@ -1772,11 +825,11 @@
|
|||
"members":{
|
||||
"Name":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>Descriptive label associated with a build. Build names do not need to be unique. A build name can be changed later using <code><a>UpdateBuild</a></code>.</p>"
|
||||
"documentation":"<p>Descriptive label associated with a build. Build names do not need to be unique. A build name can be changed later using <code> <a>UpdateBuild</a> </code>.</p>"
|
||||
},
|
||||
"Version":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>Version associated with this build. Version strings do not need to be unique to a build. A build version can be changed later using <code><a>UpdateBuild</a></code>.</p>"
|
||||
"documentation":"<p>Version associated with this build. Version strings do not need to be unique to a build. A build version can be changed later using <code> <a>UpdateBuild</a> </code>.</p>"
|
||||
},
|
||||
"StorageLocation":{"shape":"S3Location"},
|
||||
"OperatingSystem":{
|
||||
|
|
@ -1795,7 +848,7 @@
|
|||
},
|
||||
"UploadCredentials":{
|
||||
"shape":"AwsCredentials",
|
||||
"documentation":"<p>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 <code><a>RequestUploadCredentials</a></code>.</p>"
|
||||
"documentation":"<p>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 <code> <a>RequestUploadCredentials</a> </code>.</p>"
|
||||
},
|
||||
"StorageLocation":{
|
||||
"shape":"S3Location",
|
||||
|
|
@ -1838,7 +891,7 @@
|
|||
},
|
||||
"EC2InstanceType":{
|
||||
"shape":"EC2InstanceType",
|
||||
"documentation":"<p>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 <a href=\"https://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instance Types</a> for detailed descriptions.</p>"
|
||||
"documentation":"<p>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 <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instance Types</a> for detailed descriptions.</p>"
|
||||
},
|
||||
"EC2InboundPermissions":{
|
||||
"shape":"IpPermissionsList",
|
||||
|
|
@ -1846,11 +899,15 @@
|
|||
},
|
||||
"NewGameSessionProtectionPolicy":{
|
||||
"shape":"ProtectionPolicy",
|
||||
"documentation":"<p>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 <a>UpdateGameSession</a>.</p> <ul><li><b>NoProtection</b> – The game session can be terminated during a scale-down event.</li> <li><b>FullProtection</b> – If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</li></ul>"
|
||||
"documentation":"<p>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 <a>UpdateGameSession</a>.</p> <ul> <li> <p> <b>NoProtection</b> – The game session can be terminated during a scale-down event.</p> </li> <li> <p> <b>FullProtection</b> – If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</p> </li> </ul>"
|
||||
},
|
||||
"RuntimeConfiguration":{
|
||||
"shape":"RuntimeConfiguration",
|
||||
"documentation":"<p>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 <code>CreateFleet</code> 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 <code>ServerLaunchPath</code> and <code>ServerLaunchParameters</code>; requests that contain values for these parameters instead of a runtime configuration will continue to work.) </p>"
|
||||
},
|
||||
"ResourceCreationLimitPolicy":{
|
||||
"shape":"ResourceCreationLimitPolicy",
|
||||
"documentation":"<p>Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
|
|
@ -1879,7 +936,7 @@
|
|||
},
|
||||
"MaximumPlayerSessionCount":{
|
||||
"shape":"WholeNumber",
|
||||
"documentation":"<p>Maximum number of players that can be connected simultaneously to the game session. </p>"
|
||||
"documentation":"<p>Maximum number of players that can be connected simultaneously to the game session.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
|
|
@ -1887,7 +944,15 @@
|
|||
},
|
||||
"GameProperties":{
|
||||
"shape":"GamePropertyList",
|
||||
"documentation":"<p>Set of properties used to administer a game session. These properties are passed to the server process hosting it. </p>"
|
||||
"documentation":"<p>Set of properties used to administer a game session. These properties are passed to the server process hosting it.</p>"
|
||||
},
|
||||
"CreatorId":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"GameSessionId":{
|
||||
"shape":"IdStringModel",
|
||||
"documentation":"<p>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 auto-generated ID string. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
|
|
@ -1910,8 +975,8 @@
|
|||
],
|
||||
"members":{
|
||||
"GameSessionId":{
|
||||
"shape":"GameSessionId",
|
||||
"documentation":"<p>Unique identifier for a game session. Specify the game session you want to add a player to.</p>"
|
||||
"shape":"ArnStringModel",
|
||||
"documentation":"<p>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 auto-generated string. </p>"
|
||||
},
|
||||
"PlayerId":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
|
|
@ -1938,8 +1003,8 @@
|
|||
],
|
||||
"members":{
|
||||
"GameSessionId":{
|
||||
"shape":"GameSessionId",
|
||||
"documentation":"<p>Unique identifier for a game session. </p>"
|
||||
"shape":"ArnStringModel",
|
||||
"documentation":"<p>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 auto-generated string. </p>"
|
||||
},
|
||||
"PlayerIds":{
|
||||
"shape":"PlayerIdList",
|
||||
|
|
@ -1964,7 +1029,7 @@
|
|||
"members":{
|
||||
"AliasId":{
|
||||
"shape":"AliasId",
|
||||
"documentation":"<p>Unique identifier for a fleet alias. Specify the alias you want to delete. </p>"
|
||||
"documentation":"<p>Unique identifier for a fleet alias. Specify the alias you want to delete.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
|
|
@ -1975,7 +1040,7 @@
|
|||
"members":{
|
||||
"BuildId":{
|
||||
"shape":"BuildId",
|
||||
"documentation":"<p>Unique identifier for the build you want to delete. </p>"
|
||||
"documentation":"<p>Unique identifier for the build you want to delete.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
|
|
@ -2015,7 +1080,7 @@
|
|||
"members":{
|
||||
"AliasId":{
|
||||
"shape":"AliasId",
|
||||
"documentation":"<p>Unique identifier for a fleet alias. Specify the alias you want to retrieve. </p>"
|
||||
"documentation":"<p>Unique identifier for a fleet alias. Specify the alias you want to retrieve.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
|
|
@ -2036,7 +1101,7 @@
|
|||
"members":{
|
||||
"BuildId":{
|
||||
"shape":"BuildId",
|
||||
"documentation":"<p>Unique identifier of the build that you want to retrieve properties for. </p>"
|
||||
"documentation":"<p>Unique identifier of the build that you want to retrieve properties for.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
|
|
@ -2056,7 +1121,7 @@
|
|||
"members":{
|
||||
"EC2InstanceType":{
|
||||
"shape":"EC2InstanceType",
|
||||
"documentation":"<p>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 <a href=\"https://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instance Types</a> for detailed descriptions. Leave this parameter blank to retrieve limits for all types.</p>"
|
||||
"documentation":"<p>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 <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instance Types</a> for detailed descriptions. Leave this parameter blank to retrieve limits for all types.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
|
|
@ -2094,11 +1159,11 @@
|
|||
"members":{
|
||||
"FleetAttributes":{
|
||||
"shape":"FleetAttributesList",
|
||||
"documentation":"<p>Collection of objects containing attribute metadata for each requested fleet ID. </p>"
|
||||
"documentation":"<p>Collection of objects containing attribute metadata for each requested fleet ID.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>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.</p> <note> <p>If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.</p> </note>"
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
|
|
@ -2130,7 +1195,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>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.</p> <note> <p>If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.</p> </note>"
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
|
|
@ -2141,7 +1206,7 @@
|
|||
"members":{
|
||||
"FleetId":{
|
||||
"shape":"FleetId",
|
||||
"documentation":"<p>Unique identifier for the fleet to get event logs for. </p>"
|
||||
"documentation":"<p>Unique identifier for the fleet to get event logs for.</p>"
|
||||
},
|
||||
"StartTime":{
|
||||
"shape":"Timestamp",
|
||||
|
|
@ -2171,7 +1236,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>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.</p> <note> <p>If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.</p> </note>"
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
|
|
@ -2182,7 +1247,7 @@
|
|||
"members":{
|
||||
"FleetId":{
|
||||
"shape":"FleetId",
|
||||
"documentation":"<p>Unique identifier for the fleet you want to retrieve port settings for. </p>"
|
||||
"documentation":"<p>Unique identifier for the fleet you want to retrieve port settings for.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
|
|
@ -2224,7 +1289,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>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.</p> <note> <p>If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.</p> </note>"
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
|
|
@ -2237,8 +1302,8 @@
|
|||
"documentation":"<p>Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.</p>"
|
||||
},
|
||||
"GameSessionId":{
|
||||
"shape":"GameSessionId",
|
||||
"documentation":"<p>Unique identifier for a game session. Specify the game session to retrieve information on.</p>"
|
||||
"shape":"ArnStringModel",
|
||||
"documentation":"<p>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 auto-generated string. </p>"
|
||||
},
|
||||
"AliasId":{
|
||||
"shape":"AliasId",
|
||||
|
|
@ -2268,7 +1333,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>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.</p> <note> <p>If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.</p> </note>"
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
|
|
@ -2281,8 +1346,8 @@
|
|||
"documentation":"<p>Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.</p>"
|
||||
},
|
||||
"GameSessionId":{
|
||||
"shape":"GameSessionId",
|
||||
"documentation":"<p>Unique identifier for a game session. Specify the game session to retrieve information on.</p>"
|
||||
"shape":"ArnStringModel",
|
||||
"documentation":"<p>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 auto-generated string. </p>"
|
||||
},
|
||||
"AliasId":{
|
||||
"shape":"AliasId",
|
||||
|
|
@ -2312,7 +1377,44 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>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.</p> <note> <p>If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.</p> </note>"
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"DescribeInstancesInput":{
|
||||
"type":"structure",
|
||||
"required":["FleetId"],
|
||||
"members":{
|
||||
"FleetId":{
|
||||
"shape":"FleetId",
|
||||
"documentation":"<p>Unique identifier for a fleet. Specify the fleet to retrieve instance information for.</p>"
|
||||
},
|
||||
"InstanceId":{
|
||||
"shape":"InstanceId",
|
||||
"documentation":"<p>Unique identifier for an instance. Specify an instance to retrieve information for or leave blank to get information on all instances in the fleet.</p>"
|
||||
},
|
||||
"Limit":{
|
||||
"shape":"PositiveInteger",
|
||||
"documentation":"<p>Maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
},
|
||||
"DescribeInstancesOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Instances":{
|
||||
"shape":"InstanceList",
|
||||
"documentation":"<p>Collection of objects containing properties for each instance returned.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
|
|
@ -2321,8 +1423,8 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
"GameSessionId":{
|
||||
"shape":"GameSessionId",
|
||||
"documentation":"<p>Unique identifier for a game session.</p>"
|
||||
"shape":"ArnStringModel",
|
||||
"documentation":"<p>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 auto-generated string. </p>"
|
||||
},
|
||||
"PlayerId":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
|
|
@ -2334,7 +1436,7 @@
|
|||
},
|
||||
"PlayerSessionStatusFilter":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>Player session status to filter results on.</p> <p>Possible player session statuses include the following:</p> <ul><li><b>RESERVED</b> – The player session request has been received, but the player has not yet connected to the server process and/or been validated. </li><li><b>ACTIVE</b> – The player has been validated by the server process and is currently connected.</li><li><b>COMPLETED</b> – The player connection has been dropped.</li><li><b>TIMEDOUT</b> – A player session request was received, but the player did not connect and/or was not validated within the time-out limit (60 seconds).</li></ul>"
|
||||
"documentation":"<p>Player session status to filter results on.</p> <p>Possible player session statuses include the following:</p> <ul> <li> <p> <b>RESERVED</b> – The player session request has been received, but the player has not yet connected to the server process and/or been validated. </p> </li> <li> <p> <b>ACTIVE</b> – The player has been validated by the server process and is currently connected.</p> </li> <li> <p> <b>COMPLETED</b> – The player connection has been dropped.</p> </li> <li> <p> <b>TIMEDOUT</b> – A player session request was received, but the player did not connect and/or was not validated within the time-out limit (60 seconds).</p> </li> </ul>"
|
||||
},
|
||||
"Limit":{
|
||||
"shape":"PositiveInteger",
|
||||
|
|
@ -2356,7 +1458,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>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.</p> <note> <p>If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.</p> </note>"
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
|
|
@ -2392,7 +1494,7 @@
|
|||
},
|
||||
"StatusFilter":{
|
||||
"shape":"ScalingStatusType",
|
||||
"documentation":"<p>Scaling policy status to filter results on. A scaling policy is only in force when in an <code>ACTIVE</code> status.</p> <ul> <li> <b>ACTIVE</b> – The scaling policy is currently in force.</li> <li> <b>UPDATEREQUESTED</b> – A request to update the scaling policy has been received.</li> <li> <b>UPDATING</b> – A change is being made to the scaling policy.</li> <li> <b>DELETEREQUESTED</b> – A request to delete the scaling policy has been received.</li> <li> <b>DELETING</b> – The scaling policy is being deleted.</li> <li> <b>DELETED</b> – The scaling policy has been deleted.</li> <li> <b>ERROR</b> – An error occurred in creating the policy. It should be removed and recreated.</li> </ul>"
|
||||
"documentation":"<p>Scaling policy status to filter results on. A scaling policy is only in force when in an <code>ACTIVE</code> status.</p> <ul> <li> <p> <b>ACTIVE</b> – The scaling policy is currently in force.</p> </li> <li> <p> <b>UPDATEREQUESTED</b> – A request to update the scaling policy has been received.</p> </li> <li> <p> <b>UPDATING</b> – A change is being made to the scaling policy.</p> </li> <li> <p> <b>DELETEREQUESTED</b> – A request to delete the scaling policy has been received.</p> </li> <li> <p> <b>DELETING</b> – The scaling policy is being deleted.</p> </li> <li> <p> <b>DELETED</b> – The scaling policy has been deleted.</p> </li> <li> <p> <b>ERROR</b> – An error occurred in creating the policy. It should be removed and recreated.</p> </li> </ul>"
|
||||
},
|
||||
"Limit":{
|
||||
"shape":"PositiveInteger",
|
||||
|
|
@ -2414,7 +1516,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>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.</p> <note> <p>If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.</p> </note>"
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
|
|
@ -2449,7 +1551,7 @@
|
|||
},
|
||||
"TERMINATING":{
|
||||
"shape":"WholeNumber",
|
||||
"documentation":"<p>Number of instances in the fleet that are no longer active but haven't yet been terminated. </p>"
|
||||
"documentation":"<p>Number of instances in the fleet that are no longer active but haven't yet been terminated.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>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 <a>UpdateFleetCapacity</a> request, or if access to resources is temporarily affected.</p>"
|
||||
|
|
@ -2459,11 +1561,11 @@
|
|||
"members":{
|
||||
"EC2InstanceType":{
|
||||
"shape":"EC2InstanceType",
|
||||
"documentation":"<p>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 <a href=\"https://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instance Types</a> for detailed descriptions.</p>"
|
||||
"documentation":"<p>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 <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instance Types</a> for detailed descriptions.</p>"
|
||||
},
|
||||
"CurrentInstances":{
|
||||
"shape":"WholeNumber",
|
||||
"documentation":"<p>Number of instances of the specified type that are currently in use by this AWS account. </p>"
|
||||
"documentation":"<p>Number of instances of the specified type that are currently in use by this AWS account.</p>"
|
||||
},
|
||||
"InstanceLimit":{
|
||||
"shape":"WholeNumber",
|
||||
|
|
@ -2587,7 +1689,7 @@
|
|||
},
|
||||
"Status":{
|
||||
"shape":"FleetStatus",
|
||||
"documentation":"<p>Current status of the fleet.</p> <p>Possible fleet statuses include the following:</p> <ul><li><b>NEW</b> – A new fleet has been defined and desired instances is set to 1. </li><li><b>DOWNLOADING/VALIDATING/BUILDING/ACTIVATING</b> – GameLift is setting up the new fleet, creating new instances with the game build and starting server processes.</li><li><b>ACTIVE</b> – Hosts can now accept game sessions.</li><li><b>ERROR</b> – An error occurred when downloading, validating, building, or activating the fleet.</li><li><b>DELETING</b> – Hosts are responding to a delete fleet request.</li><li><b>TERMINATED</b> – The fleet no longer exists.</li></ul>"
|
||||
"documentation":"<p>Current status of the fleet.</p> <p>Possible fleet statuses include the following:</p> <ul> <li> <p> <b>NEW</b> – A new fleet has been defined and desired instances is set to 1. </p> </li> <li> <p> <b>DOWNLOADING/VALIDATING/BUILDING/ACTIVATING</b> – GameLift is setting up the new fleet, creating new instances with the game build and starting server processes.</p> </li> <li> <p> <b>ACTIVE</b> – Hosts can now accept game sessions.</p> </li> <li> <p> <b>ERROR</b> – An error occurred when downloading, validating, building, or activating the fleet.</p> </li> <li> <p> <b>DELETING</b> – Hosts are responding to a delete fleet request.</p> </li> <li> <p> <b>TERMINATED</b> – The fleet no longer exists.</p> </li> </ul>"
|
||||
},
|
||||
"BuildId":{
|
||||
"shape":"BuildId",
|
||||
|
|
@ -2595,11 +1697,11 @@
|
|||
},
|
||||
"ServerLaunchPath":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>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 <code><a>RuntimeConfiguration</a></code>.</p>"
|
||||
"documentation":"<p>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 <code> <a>RuntimeConfiguration</a> </code>.</p>"
|
||||
},
|
||||
"ServerLaunchParameters":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>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 <code><a>RuntimeConfiguration</a></code>.</p>"
|
||||
"documentation":"<p>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 <code> <a>RuntimeConfiguration</a> </code>.</p>"
|
||||
},
|
||||
"LogPaths":{
|
||||
"shape":"StringList",
|
||||
|
|
@ -2607,11 +1709,15 @@
|
|||
},
|
||||
"NewGameSessionProtectionPolicy":{
|
||||
"shape":"ProtectionPolicy",
|
||||
"documentation":"<p>Type of game session protection to set for all new instances started in the fleet.</p> <ul><li><b>NoProtection</b> – The game session can be terminated during a scale-down event.</li> <li><b>FullProtection</b> – If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</li></ul>"
|
||||
"documentation":"<p>Type of game session protection to set for all new instances started in the fleet.</p> <ul> <li> <p> <b>NoProtection</b> – The game session can be terminated during a scale-down event.</p> </li> <li> <p> <b>FullProtection</b> – If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</p> </li> </ul>"
|
||||
},
|
||||
"OperatingSystem":{
|
||||
"shape":"OperatingSystem",
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"ResourceCreationLimitPolicy":{
|
||||
"shape":"ResourceCreationLimitPolicy",
|
||||
"documentation":"<p>Fleet policy to limit the number of game sessions an individual player can create over a span of time.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>General properties describing a fleet.</p>"
|
||||
|
|
@ -2629,7 +1735,7 @@
|
|||
},
|
||||
"InstanceType":{
|
||||
"shape":"EC2InstanceType",
|
||||
"documentation":"<p>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 <a href=\"https://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instance Types</a> for detailed descriptions.</p>"
|
||||
"documentation":"<p>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 <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instance Types</a> for detailed descriptions.</p>"
|
||||
},
|
||||
"InstanceCounts":{
|
||||
"shape":"EC2InstanceCounts",
|
||||
|
|
@ -2643,8 +1749,8 @@
|
|||
"members":{
|
||||
"Message":{"shape":"NonEmptyString"}
|
||||
},
|
||||
"exception":true,
|
||||
"documentation":"<p>The specified fleet has no available instances to fulfill a request to create a new game session. Such requests should only be retried once the fleet capacity has been increased. </p>"
|
||||
"documentation":"<p>The specified fleet has no available instances to fulfill a <code>CreateGameSession</code> request. Clients can retry such requests immediately or after a waiting period.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"FleetCapacityList":{
|
||||
"type":"list",
|
||||
|
|
@ -2711,8 +1817,14 @@
|
|||
"Value"
|
||||
],
|
||||
"members":{
|
||||
"Key":{"shape":"GamePropertyKey"},
|
||||
"Value":{"shape":"GamePropertyValue"}
|
||||
"Key":{
|
||||
"shape":"GamePropertyKey",
|
||||
"documentation":"<p>TBD</p>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"GamePropertyValue",
|
||||
"documentation":"<p>TBD</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/gamelift/latest/developerguide/\">Amazon GameLift Developer Guide</a>.</p>"
|
||||
},
|
||||
|
|
@ -2733,8 +1845,8 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
"GameSessionId":{
|
||||
"shape":"GameSessionId",
|
||||
"documentation":"<p>Unique identifier for a game session.</p>"
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>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 auto-generated string. </p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
|
|
@ -2779,6 +1891,10 @@
|
|||
"PlayerSessionCreationPolicy":{
|
||||
"shape":"PlayerSessionCreationPolicy",
|
||||
"documentation":"<p>Indicates whether or not the game session is accepting new players.</p>"
|
||||
},
|
||||
"CreatorId":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>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 one player can have.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Properties describing a game session.</p>"
|
||||
|
|
@ -2789,7 +1905,7 @@
|
|||
"GameSession":{"shape":"GameSession"},
|
||||
"ProtectionPolicy":{
|
||||
"shape":"ProtectionPolicy",
|
||||
"documentation":"<p>Current status of protection for the game session.</p> <ul><li><b>NoProtection</b> – The game session can be terminated during a scale-down event.</li> <li><b>FullProtection</b> – If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</li></ul>"
|
||||
"documentation":"<p>Current status of protection for the game session.</p> <ul> <li> <p> <b>NoProtection</b> – The game session can be terminated during a scale-down event.</p> </li> <li> <p> <b>FullProtection</b> – If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A game session's properties and the protection policy currently in force.</p>"
|
||||
|
|
@ -2803,12 +1919,8 @@
|
|||
"members":{
|
||||
"Message":{"shape":"NonEmptyString"}
|
||||
},
|
||||
"exception":true,
|
||||
"documentation":"<p>The game instance is currently full and cannot allow the requested player(s) to join. This exception occurs in response to a <a>CreatePlayerSession</a> request. </p>"
|
||||
},
|
||||
"GameSessionId":{
|
||||
"type":"string",
|
||||
"pattern":"^(gamei-|gsess-)\\S+"
|
||||
"documentation":"<p>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.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"GameSessionList":{
|
||||
"type":"list",
|
||||
|
|
@ -2820,7 +1932,8 @@
|
|||
"ACTIVE",
|
||||
"ACTIVATING",
|
||||
"TERMINATED",
|
||||
"TERMINATING"
|
||||
"TERMINATING",
|
||||
"ERROR"
|
||||
]
|
||||
},
|
||||
"GetGameSessionLogUrlInput":{
|
||||
|
|
@ -2828,8 +1941,8 @@
|
|||
"required":["GameSessionId"],
|
||||
"members":{
|
||||
"GameSessionId":{
|
||||
"shape":"GameSessionId",
|
||||
"documentation":"<p>Unique identifier for a game session. Specify the game session you want to get logs for.</p>"
|
||||
"shape":"ArnStringModel",
|
||||
"documentation":"<p>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 auto-generated string. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
|
|
@ -2844,39 +1957,103 @@
|
|||
},
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"IdStringModel":{
|
||||
"type":"string",
|
||||
"max":48,
|
||||
"min":1,
|
||||
"pattern":"[a-zA-Z0-9-]+"
|
||||
},
|
||||
"IdempotentParameterMismatchException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"NonEmptyString"}
|
||||
},
|
||||
"documentation":"<p>A game session with this custom ID string already exists in this fleet. Resolve this conflict before retrying this request.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"Instance":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"FleetId":{
|
||||
"shape":"FleetId",
|
||||
"documentation":"<p>Unique identifier for the fleet that the instance belongs to.</p>"
|
||||
},
|
||||
"InstanceId":{
|
||||
"shape":"InstanceId",
|
||||
"documentation":"<p>Unique identifier for the instance.</p>"
|
||||
},
|
||||
"IpAddress":{
|
||||
"shape":"IpAddress",
|
||||
"documentation":"<p>IP address assigned to the instance.</p>"
|
||||
},
|
||||
"OperatingSystem":{
|
||||
"shape":"OperatingSystem",
|
||||
"documentation":"<p>Operating system being used on this instance. </p>"
|
||||
},
|
||||
"Type":{
|
||||
"shape":"EC2InstanceType",
|
||||
"documentation":"<p>EC2 instance type that defines the computing resources of this instance. </p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"InstanceStatus",
|
||||
"documentation":"<p>Current status of the instance. Possible statuses include the following:</p> <ul> <li> <p> <b>PENDING</b> – The instance is in the process of being created and launching server processes as defined in the fleet's runtime configuration. </p> </li> <li> <p> <b>ACTIVE</b> – 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. </p> </li> <li> <p> <b>TERMINATING</b> – 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.</p> </li> </ul>"
|
||||
},
|
||||
"CreationTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Properties describing an instance of a virtual computing resource that is hosting game servers. Fleets contain zero or more instances. </p>"
|
||||
},
|
||||
"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":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.</p>",
|
||||
"exception":true,
|
||||
"fault":true,
|
||||
"documentation":"<p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.</p>"
|
||||
"fault":true
|
||||
},
|
||||
"InvalidFleetStatusException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"NonEmptyString"}
|
||||
},
|
||||
"exception":true,
|
||||
"documentation":"<p>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.</p>"
|
||||
"documentation":"<p>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.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidGameSessionStatusException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"NonEmptyString"}
|
||||
},
|
||||
"exception":true,
|
||||
"documentation":"<p>The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Clients should not retry such requests without resolving the conflict.</p>"
|
||||
"documentation":"<p>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.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidRequestException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"NonEmptyString"}
|
||||
},
|
||||
"exception":true,
|
||||
"documentation":"<p>One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.</p>"
|
||||
"documentation":"<p>One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"IpAddress":{"type":"string"},
|
||||
"IpPermission":{
|
||||
|
|
@ -2890,7 +2067,7 @@
|
|||
"members":{
|
||||
"FromPort":{
|
||||
"shape":"PortNumber",
|
||||
"documentation":"<p>Starting value for a range of allowed port numbers. </p>"
|
||||
"documentation":"<p>Starting value for a range of allowed port numbers.</p>"
|
||||
},
|
||||
"ToPort":{
|
||||
"shape":"PortNumber",
|
||||
|
|
@ -2924,15 +2101,15 @@
|
|||
"members":{
|
||||
"Message":{"shape":"NonEmptyString"}
|
||||
},
|
||||
"exception":true,
|
||||
"documentation":"<p>The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.</p>"
|
||||
"documentation":"<p>The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ListAliasesInput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"RoutingStrategyType":{
|
||||
"shape":"RoutingStrategyType",
|
||||
"documentation":"<p>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.</p> <p>Possible routing types include the following:</p> <ul><li><b>SIMPLE</b> – The alias resolves to one specific fleet. Use this type when routing to active fleets.</li><li><b>TERMINAL</b> – 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 <a>RoutingStrategy</a> message embedded.</li></ul>"
|
||||
"documentation":"<p>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.</p> <p>Possible routing types include the following:</p> <ul> <li> <p> <b>SIMPLE</b> – The alias resolves to one specific fleet. Use this type when routing to active fleets.</p> </li> <li> <p> <b>TERMINAL</b> – 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 <a>RoutingStrategy</a> message embedded.</p> </li> </ul>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"NonEmptyString",
|
||||
|
|
@ -2954,11 +2131,11 @@
|
|||
"members":{
|
||||
"Aliases":{
|
||||
"shape":"AliasList",
|
||||
"documentation":"<p>Collection of alias records that match the list request. </p>"
|
||||
"documentation":"<p>Collection of alias records that match the list request.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>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.</p> <note> <p>If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.</p> </note>"
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
|
|
@ -2968,7 +2145,7 @@
|
|||
"members":{
|
||||
"Status":{
|
||||
"shape":"BuildStatus",
|
||||
"documentation":"<p>Build status to filter results by. To retrieve all builds, leave this parameter empty.</p> <p>Possible build statuses include the following:</p> <ul><li><b>INITIALIZED</b> – 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. </li><li><b>READY</b> – The game build has been successfully uploaded. You can now create new fleets for this build.</li><li><b>FAILED</b> – The game build upload failed. You cannot create new fleets for this build. </li></ul>"
|
||||
"documentation":"<p>Build status to filter results by. To retrieve all builds, leave this parameter empty.</p> <p>Possible build statuses include the following:</p> <ul> <li> <p> <b>INITIALIZED</b> – 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. </p> </li> <li> <p> <b>READY</b> – The game build has been successfully uploaded. You can now create new fleets for this build.</p> </li> <li> <p> <b>FAILED</b> – The game build upload failed. You cannot create new fleets for this build. </p> </li> </ul>"
|
||||
},
|
||||
"Limit":{
|
||||
"shape":"PositiveInteger",
|
||||
|
|
@ -2986,11 +2163,11 @@
|
|||
"members":{
|
||||
"Builds":{
|
||||
"shape":"BuildList",
|
||||
"documentation":"<p>Collection of build records that match the request. </p>"
|
||||
"documentation":"<p>Collection of build records that match the request.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>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.</p> <note> <p>If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.</p> </note>"
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
|
|
@ -3022,7 +2199,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>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.</p> <note> <p>If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.</p> </note>"
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
|
|
@ -3038,6 +2215,12 @@
|
|||
"IdleInstances"
|
||||
]
|
||||
},
|
||||
"NonBlankAndLengthConstraintString":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
"min":1,
|
||||
"pattern":".*\\S.*"
|
||||
},
|
||||
"NonBlankString":{
|
||||
"type":"string",
|
||||
"pattern":"[^\\s]+"
|
||||
|
|
@ -3048,16 +2231,16 @@
|
|||
},
|
||||
"NonZeroAndMaxString":{
|
||||
"type":"string",
|
||||
"min":1,
|
||||
"max":1024
|
||||
"max":1024,
|
||||
"min":1
|
||||
},
|
||||
"NotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"NonEmptyString"}
|
||||
},
|
||||
"exception":true,
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests</p>"
|
||||
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"OperatingSystem":{
|
||||
"type":"string",
|
||||
|
|
@ -3069,8 +2252,8 @@
|
|||
"PlayerIdList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"NonZeroAndMaxString"},
|
||||
"min":1,
|
||||
"max":25
|
||||
"max":25,
|
||||
"min":1
|
||||
},
|
||||
"PlayerSession":{
|
||||
"type":"structure",
|
||||
|
|
@ -3084,8 +2267,8 @@
|
|||
"documentation":"<p>Unique identifier for a player.</p>"
|
||||
},
|
||||
"GameSessionId":{
|
||||
"shape":"GameSessionId",
|
||||
"documentation":"<p>Unique identifier for a game session.</p>"
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>Unique identifier for the game session that the player session is connected to.</p>"
|
||||
},
|
||||
"FleetId":{
|
||||
"shape":"FleetId",
|
||||
|
|
@ -3101,11 +2284,11 @@
|
|||
},
|
||||
"Status":{
|
||||
"shape":"PlayerSessionStatus",
|
||||
"documentation":"<p>Current status of the player session.</p> <p>Possible player session statuses include the following:</p> <ul><li><b>RESERVED</b> – The player session request has been received, but the player has not yet connected to the server process and/or been validated. </li><li><b>ACTIVE</b> – The player has been validated by the server process and is currently connected.</li><li><b>COMPLETED</b> – The player connection has been dropped.</li><li><b>TIMEDOUT</b> – A player session request was received, but the player did not connect and/or was not validated within the time-out limit (60 seconds).</li></ul>"
|
||||
"documentation":"<p>Current status of the player session.</p> <p>Possible player session statuses include the following:</p> <ul> <li> <p> <b>RESERVED</b> – The player session request has been received, but the player has not yet connected to the server process and/or been validated. </p> </li> <li> <p> <b>ACTIVE</b> – The player has been validated by the server process and is currently connected.</p> </li> <li> <p> <b>COMPLETED</b> – The player connection has been dropped.</p> </li> <li> <p> <b>TIMEDOUT</b> – A player session request was received, but the player did not connect and/or was not validated within the time-out limit (60 seconds).</p> </li> </ul>"
|
||||
},
|
||||
"IpAddress":{
|
||||
"shape":"IpAddress",
|
||||
"documentation":"<p>Game session IP address. All player sessions reference the game session location. </p>"
|
||||
"documentation":"<p>Game session IP address. All player sessions reference the game session location.</p>"
|
||||
},
|
||||
"Port":{
|
||||
"shape":"PortNumber",
|
||||
|
|
@ -3140,8 +2323,8 @@
|
|||
},
|
||||
"PortNumber":{
|
||||
"type":"integer",
|
||||
"min":1025,
|
||||
"max":60000
|
||||
"max":60000,
|
||||
"min":1
|
||||
},
|
||||
"PositiveInteger":{
|
||||
"type":"integer",
|
||||
|
|
@ -3185,7 +2368,7 @@
|
|||
},
|
||||
"ScalingAdjustmentType":{
|
||||
"shape":"ScalingAdjustmentType",
|
||||
"documentation":"<p>Type of adjustment to make to a fleet's instance count (see <a>FleetCapacity</a>):</p> <ul> <li> <b>ChangeInCapacity</b> – add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.</li> <li> <b>ExactCapacity</b> – set the instance count to the scaling adjustment value.</li> <li> <b>PercentChangeInCapacity</b> – 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%.</li> </ul>"
|
||||
"documentation":"<p>Type of adjustment to make to a fleet's instance count (see <a>FleetCapacity</a>):</p> <ul> <li> <p> <b>ChangeInCapacity</b> – add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.</p> </li> <li> <p> <b>ExactCapacity</b> – set the instance count to the scaling adjustment value.</p> </li> <li> <p> <b>PercentChangeInCapacity</b> – 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%.</p> </li> </ul>"
|
||||
},
|
||||
"Threshold":{
|
||||
"shape":"Double",
|
||||
|
|
@ -3193,7 +2376,7 @@
|
|||
},
|
||||
"ComparisonOperator":{
|
||||
"shape":"ComparisonOperatorType",
|
||||
"documentation":"<p>Comparison operator to use when measuring the metric against the threshold value. </p>"
|
||||
"documentation":"<p>Comparison operator to use when measuring the metric against the threshold value.</p>"
|
||||
},
|
||||
"EvaluationPeriods":{
|
||||
"shape":"PositiveInteger",
|
||||
|
|
@ -3201,7 +2384,7 @@
|
|||
},
|
||||
"MetricName":{
|
||||
"shape":"MetricName",
|
||||
"documentation":"<p>Name of the Amazon GameLift-defined metric that is used to trigger an adjustment.</p> <ul> <li> <b>ActivatingGameSessions</b> – number of game sessions in the process of being created (game session status = <code>ACTIVATING</code>).</li> <li> <b>ActiveGameSessions</b> – number of game sessions currently running (game session status = <code>ACTIVE</code>).</li> <li> <b>CurrentPlayerSessions</b> – number of active or reserved player sessions (player session status = <code>ACTIVE</code> or <code>RESERVED</code>). </li> <li> <b>AvailablePlayerSessions</b> – 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 <code>PlayerSessionCreationPolicy</code> = <code>DENY_ALL</code>).</li> <li> <b>ActiveInstances</b> – number of instances currently running a game session.</li> <li> <b>IdleInstances</b> – number of instances not currently running a game session.</li> </ul>"
|
||||
"documentation":"<p>Name of the Amazon GameLift-defined metric that is used to trigger an adjustment.</p> <ul> <li> <p> <b>ActivatingGameSessions</b> – number of game sessions in the process of being created (game session status = <code>ACTIVATING</code>).</p> </li> <li> <p> <b>ActiveGameSessions</b> – number of game sessions currently running (game session status = <code>ACTIVE</code>).</p> </li> <li> <p> <b>CurrentPlayerSessions</b> – number of active or reserved player sessions (player session status = <code>ACTIVE</code> or <code>RESERVED</code>). </p> </li> <li> <p> <b>AvailablePlayerSessions</b> – 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 <code>PlayerSessionCreationPolicy</code> = <code>DENY_ALL</code>).</p> </li> <li> <p> <b>ActiveInstances</b> – number of instances currently running a game session.</p> </li> <li> <p> <b>IdleInstances</b> – number of instances not currently running a game session.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
|
|
@ -3222,7 +2405,7 @@
|
|||
"members":{
|
||||
"BuildId":{
|
||||
"shape":"BuildId",
|
||||
"documentation":"<p>Unique identifier for the build you want to get credentials for. </p>"
|
||||
"documentation":"<p>Unique identifier for the build you want to get credentials for.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
|
|
@ -3247,7 +2430,7 @@
|
|||
"members":{
|
||||
"AliasId":{
|
||||
"shape":"AliasId",
|
||||
"documentation":"<p>Unique identifier for the alias you want to resolve. </p>"
|
||||
"documentation":"<p>Unique identifier for the alias you want to resolve.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
|
|
@ -3262,12 +2445,26 @@
|
|||
},
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
},
|
||||
"ResourceCreationLimitPolicy":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NewGameSessionsPerCreator":{
|
||||
"shape":"WholeNumber",
|
||||
"documentation":"<p>Maximum number of game sessions an individual can create during the policy period. </p>"
|
||||
},
|
||||
"PolicyPeriodInMinutes":{
|
||||
"shape":"WholeNumber",
|
||||
"documentation":"<p>Time span used to evaluate the resource creation limit policy. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>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\".</p> <p>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 <code>CreateGameSession</code> request, GameLift checks that the player (identified by <code>CreatorId</code>) has created fewer than 10 game sessions in the past 60 minutes.</p>"
|
||||
},
|
||||
"RoutingStrategy":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Type":{
|
||||
"shape":"RoutingStrategyType",
|
||||
"documentation":"<p>Type of routing strategy.</p> <p>Possible routing types include the following:</p> <ul><li><b>SIMPLE</b> – The alias resolves to one specific fleet. Use this type when routing to active fleets.</li><li><b>TERMINAL</b> – 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 <a>RoutingStrategy</a> message embedded.</li></ul>"
|
||||
"documentation":"<p>Type of routing strategy.</p> <p>Possible routing types include the following:</p> <ul> <li> <p> <b>SIMPLE</b> – The alias resolves to one specific fleet. Use this type when routing to active fleets.</p> </li> <li> <p> <b>TERMINAL</b> – 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 <a>RoutingStrategy</a> message embedded.</p> </li> </ul>"
|
||||
},
|
||||
"FleetId":{
|
||||
"shape":"FleetId",
|
||||
|
|
@ -3278,7 +2475,7 @@
|
|||
"documentation":"<p>Message text to be used with a terminal routing strategy.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Routing configuration for a fleet alias. </p>"
|
||||
"documentation":"<p>Routing configuration for a fleet alias.</p>"
|
||||
},
|
||||
"RoutingStrategyType":{
|
||||
"type":"string",
|
||||
|
|
@ -3292,10 +2489,10 @@
|
|||
"members":{
|
||||
"ServerProcesses":{
|
||||
"shape":"ServerProcessList",
|
||||
"documentation":"<p>Collection of server process configurations describing what server processes to run on each instance in a fleet </p>"
|
||||
"documentation":"<p>Collection of server process configurations describing what server processes to run on each instance in a fleet</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>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.</p> <p>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.</p> <p>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 <code>ConcurrentExecutions</code> parameter for each <code><a>ServerProcess</a></code> object in the runtime configuration.</p>"
|
||||
"documentation":"<p>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.</p> <p>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.</p> <p>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 <code>ConcurrentExecutions</code> parameter for each <code> <a>ServerProcess</a> </code> object in the runtime configuration.</p>"
|
||||
},
|
||||
"S3Location":{
|
||||
"type":"structure",
|
||||
|
|
@ -3336,7 +2533,7 @@
|
|||
},
|
||||
"Status":{
|
||||
"shape":"ScalingStatusType",
|
||||
"documentation":"<p>Current status of the scaling policy. The scaling policy is only in force when in an <code>ACTIVE</code> status.</p> <ul> <li> <b>ACTIVE</b> – The scaling policy is currently in force.</li> <li> <b>UPDATE_REQUESTED</b> – A request to update the scaling policy has been received.</li> <li> <b>UPDATING</b> – A change is being made to the scaling policy.</li> <li> <b>DELETE_REQUESTED</b> – A request to delete the scaling policy has been received.</li> <li> <b>DELETING</b> – The scaling policy is being deleted.</li> <li> <b>DELETED</b> – The scaling policy has been deleted.</li> <li> <b>ERROR</b> – An error occurred in creating the policy. It should be removed and recreated.</li> </ul>"
|
||||
"documentation":"<p>Current status of the scaling policy. The scaling policy is only in force when in an <code>ACTIVE</code> status.</p> <ul> <li> <p> <b>ACTIVE</b> – The scaling policy is currently in force.</p> </li> <li> <p> <b>UPDATE_REQUESTED</b> – A request to update the scaling policy has been received.</p> </li> <li> <p> <b>UPDATING</b> – A change is being made to the scaling policy.</p> </li> <li> <p> <b>DELETE_REQUESTED</b> – A request to delete the scaling policy has been received.</p> </li> <li> <p> <b>DELETING</b> – The scaling policy is being deleted.</p> </li> <li> <p> <b>DELETED</b> – The scaling policy has been deleted.</p> </li> <li> <p> <b>ERROR</b> – An error occurred in creating the policy. It should be removed and recreated.</p> </li> </ul>"
|
||||
},
|
||||
"ScalingAdjustment":{
|
||||
"shape":"Integer",
|
||||
|
|
@ -3344,11 +2541,11 @@
|
|||
},
|
||||
"ScalingAdjustmentType":{
|
||||
"shape":"ScalingAdjustmentType",
|
||||
"documentation":"<p>Type of adjustment to make to a fleet's instance count (see <a>FleetCapacity</a>):</p> <ul> <li> <b>ChangeInCapacity</b> – add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.</li> <li> <b>ExactCapacity</b> – set the instance count to the scaling adjustment value.</li> <li> <b>PercentChangeInCapacity</b> – increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.</li> </ul>"
|
||||
"documentation":"<p>Type of adjustment to make to a fleet's instance count (see <a>FleetCapacity</a>):</p> <ul> <li> <p> <b>ChangeInCapacity</b> – add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.</p> </li> <li> <p> <b>ExactCapacity</b> – set the instance count to the scaling adjustment value.</p> </li> <li> <p> <b>PercentChangeInCapacity</b> – increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.</p> </li> </ul>"
|
||||
},
|
||||
"ComparisonOperator":{
|
||||
"shape":"ComparisonOperatorType",
|
||||
"documentation":"<p>Comparison operator to use when measuring a metric against the threshold value. </p>"
|
||||
"documentation":"<p>Comparison operator to use when measuring a metric against the threshold value.</p>"
|
||||
},
|
||||
"Threshold":{
|
||||
"shape":"Double",
|
||||
|
|
@ -3360,7 +2557,7 @@
|
|||
},
|
||||
"MetricName":{
|
||||
"shape":"MetricName",
|
||||
"documentation":"<p>Name of the GameLift-defined metric that is used to trigger an adjustment.</p> <ul> <li> <b>ActivatingGameSessions</b> – number of game sessions in the process of being created (game session status = <code>ACTIVATING</code>).</li> <li> <b>ActiveGameSessions</b> – number of game sessions currently running (game session status = <code>ACTIVE</code>).</li> <li> <b>CurrentPlayerSessions</b> – number of active or reserved player sessions (player session status = <code>ACTIVE</code> or <code>RESERVED</code>). </li> <li> <b>AvailablePlayerSessions</b> – 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 <code>PlayerSessionCreationPolicy</code> = <code>DENY_ALL</code>).</li> <li> <b>ActiveInstances</b> – number of instances currently running a game session.</li> <li> <b>IdleInstances</b> – number of instances not currently running a game session.</li> </ul>"
|
||||
"documentation":"<p>Name of the GameLift-defined metric that is used to trigger an adjustment.</p> <ul> <li> <p> <b>ActivatingGameSessions</b> – number of game sessions in the process of being created (game session status = <code>ACTIVATING</code>).</p> </li> <li> <p> <b>ActiveGameSessions</b> – number of game sessions currently running (game session status = <code>ACTIVE</code>).</p> </li> <li> <p> <b>CurrentPlayerSessions</b> – number of active or reserved player sessions (player session status = <code>ACTIVE</code> or <code>RESERVED</code>). </p> </li> <li> <p> <b>AvailablePlayerSessions</b> – 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 <code>PlayerSessionCreationPolicy</code> = <code>DENY_ALL</code>).</p> </li> <li> <p> <b>ActiveInstances</b> – number of instances currently running a game session.</p> </li> <li> <p> <b>IdleInstances</b> – number of instances not currently running a game session.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.</p>"
|
||||
|
|
@ -3394,11 +2591,11 @@
|
|||
},
|
||||
"FilterExpression":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>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. </p> <p>A filter expression can contain one or multiple conditions. Each condition consists of the following:</p> <ul> <li> <b>Operand</b> -- Name of a game session attribute. Valid values are <code>gameSessionName</code>, <code>gameSessionId</code>, <code>creationTimeMillis</code>, <code>playerSessionCount</code>, <code>maximumSessions</code>, <code>hasAvailablePlayerSessions</code>.</li> <li> <b>Comparator</b> -- Valid comparators are: <code>=</code>, <code>&lt;&gt;</code>, <code>&lt;</code>, <code>&gt;</code>, <code>&lt;=</code>, <code>&gt;=</code>. </li> <li> <b>Value</b> -- 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 <code>=</code> and <code>&lt;&gt;</code>. For example, the following filter expression searches on <code>gameSessionName</code>: \"<code>FilterExpression\": \"gameSessionName = 'Matt\\\\'s Awesome Game 1'\"</code>. </li> </ul> <p>To chain multiple conditions in a single expression, use the logical keywords <code>AND</code>, <code>OR</code>, and <code>NOT</code> and parentheses as needed. For example: <code>x AND y AND NOT z</code>, <code>NOT (x OR y)</code>.</p> <p> Session search evaluates conditions from left to right using the following precedence rules: </p> <ol> <li> <code>=</code>, <code>&lt;&gt;</code>, <code>&lt;</code>, <code>&gt;</code>, <code>&lt;=</code>, <code>&gt;=</code> </li> <li>Parentheses </li> <li>NOT</li> <li>AND</li> <li>OR</li> </ol> <p>For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: <code>\"maximumSessions&gt;=10 AND hasAvailablePlayerSessions=true\"</code>. </p>"
|
||||
"documentation":"<p>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.</p> <p>A filter expression can contain one or multiple conditions. Each condition consists of the following:</p> <ul> <li> <p> <b>Operand</b> -- Name of a game session attribute. Valid values are <code>gameSessionName</code>, <code>gameSessionId</code>, <code>creationTimeMillis</code>, <code>playerSessionCount</code>, <code>maximumSessions</code>, <code>hasAvailablePlayerSessions</code>.</p> </li> <li> <p> <b>Comparator</b> -- Valid comparators are: <code>=</code>, <code><></code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>. </p> </li> <li> <p> <b>Value</b> -- 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 <code>=</code> and <code><></code>. For example, the following filter expression searches on <code>gameSessionName</code>: \"<code>FilterExpression\": \"gameSessionName = 'Matt\\\\'s Awesome Game 1'\"</code>. </p> </li> </ul> <p>To chain multiple conditions in a single expression, use the logical keywords <code>AND</code>, <code>OR</code>, and <code>NOT</code> and parentheses as needed. For example: <code>x AND y AND NOT z</code>, <code>NOT (x OR y)</code>.</p> <p>Session search evaluates conditions from left to right using the following precedence rules:</p> <ol> <li> <p> <code>=</code>, <code><></code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code> </p> </li> <li> <p>Parentheses</p> </li> <li> <p>NOT</p> </li> <li> <p>AND</p> </li> <li> <p>OR</p> </li> </ol> <p>For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: <code>\"maximumSessions>=10 AND hasAvailablePlayerSessions=true\"</code>. </p>"
|
||||
},
|
||||
"SortExpression":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>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: </p> <ul> <li> <b>Operand</b> -- Name of a game session attribute. Valid values are <code>gameSessionName</code>, <code>gameSessionId</code>, <code>creationTimeMillis</code>, <code>playerSessionCount</code>, <code>maximumSessions</code>, <code>hasAvailablePlayerSessions</code>.</li> <li> <b>Order</b> -- Valid sort orders are <code>ASC</code> (ascending) and <code>DESC</code> (descending).</li> </ul> <p>For example, this sort expression returns the oldest active sessions first: <code>\"SortExpression\": \"creationTimeMillis ASC\"</code>. Results with a null value for the sort operand are returned at the end of the list.</p>"
|
||||
"documentation":"<p>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:</p> <ul> <li> <p> <b>Operand</b> -- Name of a game session attribute. Valid values are <code>gameSessionName</code>, <code>gameSessionId</code>, <code>creationTimeMillis</code>, <code>playerSessionCount</code>, <code>maximumSessions</code>, <code>hasAvailablePlayerSessions</code>.</p> </li> <li> <p> <b>Order</b> -- Valid sort orders are <code>ASC</code> (ascending) and <code>DESC</code> (descending).</p> </li> </ul> <p>For example, this sort expression returns the oldest active sessions first: <code>\"SortExpression\": \"creationTimeMillis ASC\"</code>. Results with a null value for the sort operand are returned at the end of the list.</p>"
|
||||
},
|
||||
"Limit":{
|
||||
"shape":"PositiveInteger",
|
||||
|
|
@ -3420,7 +2617,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"documentation":"<p>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.</p> <note> <p>If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.</p> </note>"
|
||||
"documentation":"<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the returned data in response to a request action.</p>"
|
||||
|
|
@ -3442,16 +2639,16 @@
|
|||
},
|
||||
"ConcurrentExecutions":{
|
||||
"shape":"PositiveInteger",
|
||||
"documentation":"<p>Number of server processes using this configuration to run concurrently on an instance. </p>"
|
||||
"documentation":"<p>Number of server processes using this configuration to run concurrently on an instance.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>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 <code><a>RuntimeConfiguration</a></code>.</p>"
|
||||
"documentation":"<p>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 <code> <a>RuntimeConfiguration</a> </code>.</p>"
|
||||
},
|
||||
"ServerProcessList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ServerProcess"},
|
||||
"min":1,
|
||||
"max":50
|
||||
"max":50,
|
||||
"min":1
|
||||
},
|
||||
"StringList":{
|
||||
"type":"list",
|
||||
|
|
@ -3462,8 +2659,8 @@
|
|||
"members":{
|
||||
"Message":{"shape":"NonEmptyString"}
|
||||
},
|
||||
"exception":true,
|
||||
"documentation":"<p>The service is unable to resolve the routing for a particular alias because it has a terminal <a>RoutingStrategy</a> 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. </p>"
|
||||
"documentation":"<p>The service is unable to resolve the routing for a particular alias because it has a terminal <a>RoutingStrategy</a> 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. </p>",
|
||||
"exception":true
|
||||
},
|
||||
"Timestamp":{"type":"timestamp"},
|
||||
"UnauthorizedException":{
|
||||
|
|
@ -3471,8 +2668,8 @@
|
|||
"members":{
|
||||
"Message":{"shape":"NonEmptyString"}
|
||||
},
|
||||
"exception":true,
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests</p>"
|
||||
"documentation":"<p>The client failed authentication. Clients should not retry such requests.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"UpdateAliasInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -3480,10 +2677,10 @@
|
|||
"members":{
|
||||
"AliasId":{
|
||||
"shape":"AliasId",
|
||||
"documentation":"<p>Unique identifier for a fleet alias. Specify the alias you want to update. </p>"
|
||||
"documentation":"<p>Unique identifier for a fleet alias. Specify the alias you want to update.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
"shape":"NonBlankAndLengthConstraintString",
|
||||
"documentation":"<p>Descriptive label associated with an alias. Alias names do not need to be unique.</p>"
|
||||
},
|
||||
"Description":{
|
||||
|
|
@ -3513,7 +2710,7 @@
|
|||
"members":{
|
||||
"BuildId":{
|
||||
"shape":"BuildId",
|
||||
"documentation":"<p>Unique identifier of the build you want to update. </p>"
|
||||
"documentation":"<p>Unique identifier of the build you want to update.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
|
|
@ -3542,7 +2739,7 @@
|
|||
"members":{
|
||||
"FleetId":{
|
||||
"shape":"FleetId",
|
||||
"documentation":"<p>Unique identifier for the fleet you want to update attribute metadata for. </p>"
|
||||
"documentation":"<p>Unique identifier for the fleet you want to update attribute metadata for.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"NonZeroAndMaxString",
|
||||
|
|
@ -3554,7 +2751,11 @@
|
|||
},
|
||||
"NewGameSessionProtectionPolicy":{
|
||||
"shape":"ProtectionPolicy",
|
||||
"documentation":"<p>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 <a>UpdateGameSession</a>.</p> <ul><li><b>NoProtection</b> – The game session can be terminated during a scale-down event.</li> <li><b>FullProtection</b> – If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</li></ul>"
|
||||
"documentation":"<p>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 <a>UpdateGameSession</a>.</p> <ul> <li> <p> <b>NoProtection</b> – The game session can be terminated during a scale-down event.</p> </li> <li> <p> <b>FullProtection</b> – If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</p> </li> </ul>"
|
||||
},
|
||||
"ResourceCreationLimitPolicy":{
|
||||
"shape":"ResourceCreationLimitPolicy",
|
||||
"documentation":"<p>Policy that limits the number of game sessions an individual player can create over a span of time. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
|
|
@ -3575,7 +2776,7 @@
|
|||
"members":{
|
||||
"FleetId":{
|
||||
"shape":"FleetId",
|
||||
"documentation":"<p>Unique identifier for the fleet you want to update capacity for. </p>"
|
||||
"documentation":"<p>Unique identifier for the fleet you want to update capacity for.</p>"
|
||||
},
|
||||
"DesiredInstances":{
|
||||
"shape":"WholeNumber",
|
||||
|
|
@ -3608,7 +2809,7 @@
|
|||
"members":{
|
||||
"FleetId":{
|
||||
"shape":"FleetId",
|
||||
"documentation":"<p>Unique identifier for the fleet you want to update port settings for. </p>"
|
||||
"documentation":"<p>Unique identifier for the fleet you want to update port settings for.</p>"
|
||||
},
|
||||
"InboundPermissionAuthorizations":{
|
||||
"shape":"IpPermissionsList",
|
||||
|
|
@ -3636,8 +2837,8 @@
|
|||
"required":["GameSessionId"],
|
||||
"members":{
|
||||
"GameSessionId":{
|
||||
"shape":"GameSessionId",
|
||||
"documentation":"<p>Unique identifier for a game session. Specify the game session you want to update. </p>"
|
||||
"shape":"ArnStringModel",
|
||||
"documentation":"<p>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 auto-generated string. </p>"
|
||||
},
|
||||
"MaximumPlayerSessionCount":{
|
||||
"shape":"WholeNumber",
|
||||
|
|
@ -3653,7 +2854,7 @@
|
|||
},
|
||||
"ProtectionPolicy":{
|
||||
"shape":"ProtectionPolicy",
|
||||
"documentation":"<p>Game session protection policy to apply to this game session only.</p> <ul><li><b>NoProtection</b> – The game session can be terminated during a scale-down event.</li> <li><b>FullProtection</b> – If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</li></ul>"
|
||||
"documentation":"<p>Game session protection policy to apply to this game session only.</p> <ul> <li> <p> <b>NoProtection</b> – The game session can be terminated during a scale-down event.</p> </li> <li> <p> <b>FullProtection</b> – If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input for a request action.</p>"
|
||||
|
|
@ -3701,6 +2902,5 @@
|
|||
"min":0
|
||||
}
|
||||
},
|
||||
"examples":{
|
||||
}
|
||||
"documentation":"<fullname>Amazon GameLift Service</fullname> <p>Welcome to the <i>Amazon GameLift API Reference</i>. 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.</p> <p>This reference describes the low-level service API for GameLift. You can call this API directly or use the <a href=\"http://aws.amazon.com/tools/#sdk\">AWS SDK</a> for your preferred language. The AWS SDK includes a set of high-level GameLift actions multiplayer game sessions. Alternatively, you can use the <a href=\"http://aws.amazon.com/cli/\">AWS command-line interface</a> (CLI) tool, which includes commands for GameLift. For administrative actions, you can also use the Amazon GameLift console. </p> <p> <b>More Resources</b> </p> <ul> <li> <p> <a href=\"http://docs.aws.amazon.com/gamelift/latest/developerguide/\">Amazon GameLift Developer Guide</a>: Learn more about GameLift features and how to use them </p> </li> <li> <p> <a href=\"https://gamedev.amazon.com/forums/tutorials\">Lumberyard and GameLift Tutorials</a>: Get started fast with walkthroughs and sample projects</p> </li> <li> <p> <a href=\"http://aws.amazon.com/blogs/gamedev/\">GameDev Blog</a>: Stay up to date with new features and techniques</p> </li> <li> <p> <a href=\"https://gamedev.amazon.com/forums/spaces/123/gamelift-discussion.html\">GameDev Forums</a>: Connect with the GameDev community</p> </li> </ul> <p> <b>Manage Games and Players Through GameLift</b> </p> <p>Call these actions from your game clients and/or services to create and manage multiplayer game sessions and player sessions.</p> <ul> <li> <p> <b>Game sessions:</b> </p> <ul> <li> <p> <a>CreateGameSession</a> </p> </li> <li> <p> <a>DescribeGameSessions</a> </p> </li> <li> <p> <a>DescribeGameSessionDetails</a> </p> </li> <li> <p> <a>UpdateGameSession</a> </p> </li> <li> <p> <a>SearchGameSessions</a> </p> </li> </ul> </li> <li> <p> <b>Player sessions:</b> </p> <ul> <li> <p> <a>CreatePlayerSession</a> </p> </li> <li> <p> <a>CreatePlayerSessions</a> </p> </li> <li> <p> <a>DescribePlayerSessions</a> </p> </li> </ul> </li> <li> <p> <b>Other actions:</b> </p> <ul> <li> <p> <a>GetGameSessionLogUrl</a> </p> </li> </ul> </li> </ul> <p> <b>Set Up and Manage Game Servers</b> </p> <p>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.</p> <ul> <li> <p> <b>Game builds:</b> </p> <ul> <li> <p> <a>ListBuilds</a> </p> </li> <li> <p> <a>CreateBuild</a> </p> </li> <li> <p> <a>DescribeBuild</a> </p> </li> <li> <p> <a>UpdateBuild</a> </p> </li> <li> <p> <a>DeleteBuild</a> </p> </li> <li> <p> <a>RequestUploadCredentials</a> </p> </li> </ul> </li> <li> <p> <b>Fleets:</b> </p> <ul> <li> <p> <a>ListFleets</a> </p> </li> <li> <p> <a>CreateFleet</a> </p> </li> <li> <p>Describe fleets:</p> <ul> <li> <p> <a>DescribeFleetAttributes</a> </p> </li> <li> <p> <a>DescribeFleetCapacity</a> </p> </li> <li> <p> <a>DescribeFleetPortSettings</a> </p> </li> <li> <p> <a>DescribeFleetUtilization</a> </p> </li> <li> <p> <a>DescribeEC2InstanceLimits</a> </p> </li> <li> <p> <a>DescribeFleetEvents</a> </p> </li> <li> <p> <a>DescribeRuntimeConfiguration</a> </p> </li> </ul> </li> <li> <p>Update fleets:</p> <ul> <li> <p> <a>UpdateFleetAttributes</a> </p> </li> <li> <p> <a>UpdateFleetCapacity</a> </p> </li> <li> <p> <a>UpdateFleetPortSettings</a> </p> </li> <li> <p> <a>UpdateRuntimeConfiguration</a> </p> </li> </ul> </li> <li> <p> <a>DeleteFleet</a> </p> </li> </ul> </li> <li> <p> <b>Manage fleet aliases:</b> </p> <ul> <li> <p> <a>ListAliases</a> </p> </li> <li> <p> <a>CreateAlias</a> </p> </li> <li> <p> <a>DescribeAlias</a> </p> </li> <li> <p> <a>UpdateAlias</a> </p> </li> <li> <p> <a>DeleteAlias</a> </p> </li> <li> <p> <a>ResolveAlias</a> </p> </li> </ul> </li> <li> <p> <b>Manage autoscaling:</b> </p> <ul> <li> <p> <a>PutScalingPolicy</a> </p> </li> <li> <p> <a>DescribeScalingPolicies</a> </p> </li> <li> <p> <a>DeleteScalingPolicy</a> </p> </li> </ul> </li> </ul> <p>To view changes to the API, see the GameLift <a href=\"http://docs.aws.amazon.com/gamelift/latest/developerguide/doc-history.html\">Document History</a> page.</p>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3107,6 +3107,10 @@
|
|||
"shape":"DynamoDBAction",
|
||||
"documentation":"<p>Write to a DynamoDB table.</p>"
|
||||
},
|
||||
"dynamoDBv2":{
|
||||
"shape":"DynamoDBv2Action",
|
||||
"documentation":"<p>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.</p>"
|
||||
},
|
||||
"lambda":{
|
||||
"shape":"LambdaAction",
|
||||
"documentation":"<p>Invoke a Lambda function.</p>"
|
||||
|
|
@ -4215,6 +4219,20 @@
|
|||
},
|
||||
"documentation":"<p>Describes an action to write to a DynamoDB table.</p> <p>The <code>tableName</code>, <code>hashKeyField</code>, and <code>rangeKeyField</code> values must match the values used when you created the table.</p> <p>The <code>hashKeyValue</code> and <code>rangeKeyvalue</code> fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${<i>sql-expression</i>}.</p> <p>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:</p> <p><code>\"hashKeyValue\": \"${topic(3)}\"</code></p> <p>The following field uses the timestamp:</p> <p><code>\"rangeKeyValue\": \"${timestamp()}\"</code></p>"
|
||||
},
|
||||
"DynamoDBv2Action":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"roleArn":{
|
||||
"shape":"AwsArn",
|
||||
"documentation":"<p>The ARN of the IAM role that grants access to the DynamoDB table.</p>"
|
||||
},
|
||||
"putItem":{
|
||||
"shape":"PutItemInput",
|
||||
"documentation":"<p>Specifies the DynamoDB table to which the message data will be written. For example:</p> <p><code>{ \"dynamoDBv2\": { \"roleArn\": \"aws:iam:12341251:my-role\" \"putItem\": { \"tableName\": \"my-table\" } } }</code></p> <p>Each attribute in the message payload will be written to a separate column in the DynamoDB database.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes an action to write to a DynamoDB table.</p> <p>This DynamoDB action writes each attribute in the message payload into it's own column in the DynamoDB table.</p>"
|
||||
},
|
||||
"DynamoKeyType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -5226,6 +5244,17 @@
|
|||
"type":"string",
|
||||
"min":1
|
||||
},
|
||||
"PutItemInput":{
|
||||
"type":"structure",
|
||||
"required":["tableName"],
|
||||
"members":{
|
||||
"tableName":{
|
||||
"shape":"TableName",
|
||||
"documentation":"<p>The table where the message data will be written</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.</p>"
|
||||
},
|
||||
"QueueUrl":{"type":"string"},
|
||||
"RangeKeyField":{"type":"string"},
|
||||
"RangeKeyValue":{"type":"string"},
|
||||
|
|
|
|||
|
|
@ -694,7 +694,10 @@
|
|||
},
|
||||
"Input":{
|
||||
"type":"structure",
|
||||
"required":["NamePrefix"],
|
||||
"required":[
|
||||
"NamePrefix",
|
||||
"InputSchema"
|
||||
],
|
||||
"members":{
|
||||
"NamePrefix":{
|
||||
"shape":"InAppStreamName",
|
||||
|
|
@ -1559,7 +1562,8 @@
|
|||
"UnableToDetectSchemaException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"ErrorMessage"}
|
||||
"message":{"shape":"ErrorMessage"},
|
||||
"RawInputRecords":{"shape":"RawInputRecords"}
|
||||
},
|
||||
"documentation":"<p>Data format is not valid, Kinesis Analytics is not able to detect schema for the given streaming source.</p>",
|
||||
"exception":true
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -818,7 +818,6 @@ BUILTIN_HANDLERS = [
|
|||
('choose-signer.cognito-idp.SetUserSettings', disable_signing),
|
||||
('choose-signer.cognito-idp.GetJWKS', disable_signing),
|
||||
('choose-signer.cognito-idp.DeleteUserAttributes', disable_signing),
|
||||
('before-sign.s3', utils.fix_s3_host),
|
||||
('before-parameter-build.s3.HeadObject', sse_md5),
|
||||
('before-parameter-build.s3.GetObject', sse_md5),
|
||||
('before-parameter-build.s3.PutObject', sse_md5),
|
||||
|
|
|
|||
|
|
@ -45,8 +45,8 @@ RESTRICTED_REGIONS = [
|
|||
'us-gov-west-1',
|
||||
'fips-us-gov-west-1',
|
||||
]
|
||||
S3_ACCELERATE_ENDPOINT = 's3-accelerate.amazonaws.com'
|
||||
RETRYABLE_HTTP_ERRORS = (requests.Timeout, requests.ConnectionError)
|
||||
S3_ACCELERATE_WHITELIST = ['dualstack']
|
||||
|
||||
|
||||
class _RetriesExceededError(Exception):
|
||||
|
|
@ -775,7 +775,13 @@ def switch_host_s3_accelerate(request, operation_name, **kwargs):
|
|||
# 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.
|
||||
endpoint = 'https://' + S3_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)
|
||||
|
|
|
|||
|
|
@ -54,7 +54,7 @@ copyright = u'2013, Mitch Garnaat'
|
|||
# The short X.Y version.
|
||||
version = '1.4.'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '1.4.60'
|
||||
release = '1.4.64'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
|
|
|||
44
tests/functional/test_client_metadata.py
Normal file
44
tests/functional/test_client_metadata.py
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
# 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)
|
||||
|
|
@ -322,7 +322,6 @@ class TestGeneratePresigned(BaseS3OperationTest):
|
|||
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.
|
||||
|
|
@ -401,7 +400,6 @@ def test_correct_url_used_for_s3():
|
|||
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(
|
||||
|
|
@ -413,6 +411,7 @@ def test_correct_url_used_for_s3():
|
|||
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',
|
||||
|
|
@ -426,6 +425,21 @@ def test_correct_url_used_for_s3():
|
|||
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(
|
||||
|
|
@ -445,19 +459,22 @@ def test_correct_url_used_for_s3():
|
|||
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')
|
||||
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')
|
||||
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')
|
||||
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.
|
||||
|
|
@ -471,6 +488,73 @@ def test_correct_url_used_for_s3():
|
|||
# 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):
|
||||
|
|
|
|||
|
|
@ -114,7 +114,8 @@ class TestCreateClientArgs(unittest.TestCase):
|
|||
bridge.resolve.return_value = {
|
||||
'region_name': 'us-west-2', 'signature_version': 'v4',
|
||||
'endpoint_url': 'https://ec2/',
|
||||
'signing_name': 'ec2', 'signing_region': 'us-west-2'}
|
||||
'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,
|
||||
|
|
|
|||
|
|
@ -248,6 +248,26 @@ class TestAutoGeneratedClient(unittest.TestCase):
|
|||
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_api_version_is_passed_to_loader_if_provided(self):
|
||||
creator = self.create_client_creator()
|
||||
self.endpoint.host = 'https://foo.bar'
|
||||
|
|
@ -1142,32 +1162,32 @@ class TestAutoGeneratedClient(unittest.TestCase):
|
|||
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('myservice', 'us-west-2')
|
||||
self.assertNotIn(
|
||||
client = creator.create_client('s3', 'us-west-2')
|
||||
self.assertIn(
|
||||
mock.call('before-sign.s3', utils.fix_s3_host),
|
||||
client.meta.events.unregister.call_args_list
|
||||
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(
|
||||
'myservice', 'us-west-2',
|
||||
's3', 'us-west-2',
|
||||
scoped_config={'s3': {'addressing_style': 'auto'}}
|
||||
)
|
||||
self.assertNotIn(
|
||||
self.assertIn(
|
||||
mock.call('before-sign.s3', utils.fix_s3_host),
|
||||
client.meta.events.unregister.call_args_list
|
||||
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(
|
||||
'myservice', 'us-west-2',
|
||||
's3', 'us-west-2',
|
||||
scoped_config={'s3': {'addressing_style': 'virtual'}}
|
||||
)
|
||||
self.assertIn(
|
||||
self.assertNotIn(
|
||||
mock.call('before-sign.s3', utils.fix_s3_host),
|
||||
client.meta.events.unregister.call_args_list
|
||||
)
|
||||
|
|
@ -1180,7 +1200,7 @@ class TestAutoGeneratedClient(unittest.TestCase):
|
|||
event_emitter = mock.Mock()
|
||||
creator = self.create_client_creator(event_emitter=event_emitter)
|
||||
client = creator.create_client(
|
||||
'myservice', 'us-west-2',
|
||||
's3', 'us-west-2',
|
||||
scoped_config={'s3': {'addressing_style': 'path'}}
|
||||
)
|
||||
self.assertNotIn(
|
||||
|
|
@ -1192,26 +1212,38 @@ class TestAutoGeneratedClient(unittest.TestCase):
|
|||
client.meta.events.register.call_args_list
|
||||
)
|
||||
|
||||
def test_custom_endpoint_unregisters_fix_s3_host(self):
|
||||
def test_custom_endpoint_uses_path_style(self):
|
||||
event_emitter = mock.Mock()
|
||||
creator = self.create_client_creator(event_emitter=event_emitter)
|
||||
|
||||
# It shouldn't be unregistered if we don't provide a url
|
||||
client = creator.create_client('myservice', 'us-west-2')
|
||||
self.assertNotIn(
|
||||
mock.call('before-sign.s3', utils.fix_s3_host),
|
||||
client.meta.events.unregister.call_args_list
|
||||
)
|
||||
|
||||
# If we do provide a url, it must be unregistered
|
||||
event_emitter.reset_mock()
|
||||
client = creator.create_client(
|
||||
'myservice', 'us-west-2',
|
||||
endpoint_url="foo.com"
|
||||
)
|
||||
# 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.unregister.call_args_list
|
||||
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):
|
||||
|
|
|
|||
|
|
@ -51,6 +51,7 @@ 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):
|
||||
|
|
@ -973,6 +974,8 @@ class TestSwitchHostS3Accelerate(unittest.TestCase):
|
|||
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')
|
||||
|
|
@ -989,7 +992,7 @@ class TestSwitchHostS3Accelerate(unittest.TestCase):
|
|||
'CreateBucket'
|
||||
]
|
||||
for op_name in blacklist_ops:
|
||||
switch_host_s3_accelerate(self.request, 'ListBuckets')
|
||||
switch_host_s3_accelerate(self.request, op_name)
|
||||
self.assertEqual(self.request.url, self.original_url)
|
||||
|
||||
def test_uses_original_endpoint_scheme(self):
|
||||
|
|
@ -999,6 +1002,19 @@ class TestSwitchHostS3Accelerate(unittest.TestCase):
|
|||
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 TestS3RegionRedirector(unittest.TestCase):
|
||||
def setUp(self):
|
||||
|
|
|
|||
Loading…
Reference in a new issue