Imported Debian patch 0.62.0-1
This commit is contained in:
TANIGUCHI Takaki
commit
014dfbb1c5
11
PKG-INFO
11
PKG-INFO
|
|
@ -1,6 +1,6 @@
|
|||
Metadata-Version: 1.1
|
||||
Name: botocore
|
||||
Version: 0.55.0
|
||||
Version: 0.62.0
|
||||
Summary: Low-level, data-driven core of boto 3.
|
||||
Home-page: https://github.com/boto/botocore
|
||||
Author: Mitch Garnaat
|
||||
|
|
@ -21,7 +21,11 @@ language governing permissions and limitations under the License.
|
|||
Description: botocore
|
||||
========
|
||||
|
||||
|Build Status|
|
||||
.. image:: https://secure.travis-ci.org/boto/botocore.png?branch=develop
|
||||
:target: http://travis-ci.org/boto/botocore
|
||||
|
||||
.. image:: https://coveralls.io/repos/boto/botocore/badge.png?branch=develop
|
||||
:target: https://coveralls.io/r/boto/botocore?branch=master
|
||||
|
||||
A low-level interface to a growing number of Amazon Web Services. The
|
||||
botocore package is the foundation for
|
||||
|
|
@ -29,9 +33,6 @@ Description: botocore
|
|||
|
||||
`Documentation <https://botocore.readthedocs.org/en/latest/>`__
|
||||
|
||||
.. |Build Status| image:: https://travis-ci.org/boto/botocore.png?branch=develop
|
||||
:target: https://travis-ci.org/boto/botocore
|
||||
|
||||
Platform: UNKNOWN
|
||||
Classifier: Development Status :: 3 - Alpha
|
||||
Classifier: Intended Audience :: Developers
|
||||
|
|
|
|||
|
|
@ -1,13 +1,14 @@
|
|||
botocore
|
||||
========
|
||||
|
||||
|Build Status|
|
||||
.. image:: https://secure.travis-ci.org/boto/botocore.png?branch=develop
|
||||
:target: http://travis-ci.org/boto/botocore
|
||||
|
||||
.. image:: https://coveralls.io/repos/boto/botocore/badge.png?branch=develop
|
||||
:target: https://coveralls.io/r/boto/botocore?branch=master
|
||||
|
||||
A low-level interface to a growing number of Amazon Web Services. The
|
||||
botocore package is the foundation for
|
||||
`AWS-CLI <https://github.com/aws/aws-cli>`__.
|
||||
|
||||
`Documentation <https://botocore.readthedocs.org/en/latest/>`__
|
||||
|
||||
.. |Build Status| image:: https://travis-ci.org/boto/botocore.png?branch=develop
|
||||
:target: https://travis-ci.org/boto/botocore
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
Metadata-Version: 1.1
|
||||
Name: botocore
|
||||
Version: 0.55.0
|
||||
Version: 0.62.0
|
||||
Summary: Low-level, data-driven core of boto 3.
|
||||
Home-page: https://github.com/boto/botocore
|
||||
Author: Mitch Garnaat
|
||||
|
|
@ -21,7 +21,11 @@ language governing permissions and limitations under the License.
|
|||
Description: botocore
|
||||
========
|
||||
|
||||
|Build Status|
|
||||
.. image:: https://secure.travis-ci.org/boto/botocore.png?branch=develop
|
||||
:target: http://travis-ci.org/boto/botocore
|
||||
|
||||
.. image:: https://coveralls.io/repos/boto/botocore/badge.png?branch=develop
|
||||
:target: https://coveralls.io/r/boto/botocore?branch=master
|
||||
|
||||
A low-level interface to a growing number of Amazon Web Services. The
|
||||
botocore package is the foundation for
|
||||
|
|
@ -29,9 +33,6 @@ Description: botocore
|
|||
|
||||
`Documentation <https://botocore.readthedocs.org/en/latest/>`__
|
||||
|
||||
.. |Build Status| image:: https://travis-ci.org/boto/botocore.png?branch=develop
|
||||
:target: https://travis-ci.org/boto/botocore
|
||||
|
||||
Platform: UNKNOWN
|
||||
Classifier: Development Status :: 3 - Alpha
|
||||
Classifier: Intended Audience :: Developers
|
||||
|
|
|
|||
|
|
@ -46,6 +46,8 @@ botocore/data/aws/cloudsearch/2013-01-01.json
|
|||
botocore/data/aws/cloudsearchdomain/2013-01-01.json
|
||||
botocore/data/aws/cloudtrail/2013-11-01.json
|
||||
botocore/data/aws/cloudwatch/2010-08-01.json
|
||||
botocore/data/aws/cognito-identity/2014-06-30.json
|
||||
botocore/data/aws/cognito-sync/2014-06-30.json
|
||||
botocore/data/aws/datapipeline/2012-10-29.json
|
||||
botocore/data/aws/directconnect/2012-10-25.json
|
||||
botocore/data/aws/dynamodb/2011-12-05.json
|
||||
|
|
@ -54,9 +56,11 @@ botocore/data/aws/ec2/2013-02-01.json
|
|||
botocore/data/aws/ec2/2013-10-15.json
|
||||
botocore/data/aws/ec2/2014-02-01.json
|
||||
botocore/data/aws/ec2/2014-05-01.json
|
||||
botocore/data/aws/ec2/2014-06-15.json
|
||||
botocore/data/aws/elasticache/2012-11-15.json
|
||||
botocore/data/aws/elasticache/2013-06-15.json
|
||||
botocore/data/aws/elasticache/2014-03-24.json
|
||||
botocore/data/aws/elasticache/2014-07-15.json
|
||||
botocore/data/aws/elasticbeanstalk/2010-12-01.json
|
||||
botocore/data/aws/elastictranscoder/2012-09-25.json
|
||||
botocore/data/aws/elb/2012-06-01.json
|
||||
|
|
@ -64,6 +68,7 @@ botocore/data/aws/emr/2009-03-31.json
|
|||
botocore/data/aws/iam/2010-05-08.json
|
||||
botocore/data/aws/importexport/2010-06-01.json
|
||||
botocore/data/aws/kinesis/2013-12-02.json
|
||||
botocore/data/aws/logs/2014-03-28.json
|
||||
botocore/data/aws/opsworks/2013-02-18.json
|
||||
botocore/data/aws/rds/2013-01-10.json
|
||||
botocore/data/aws/rds/2013-02-12.json
|
||||
|
|
@ -72,6 +77,7 @@ botocore/data/aws/rds/2013-09-09.json
|
|||
botocore/data/aws/redshift/2012-12-01.json
|
||||
botocore/data/aws/route53/2012-12-12.json
|
||||
botocore/data/aws/route53/2013-04-01.json
|
||||
botocore/data/aws/route53domains/2014-05-15.json
|
||||
botocore/data/aws/s3/2006-03-01.json
|
||||
botocore/data/aws/sdb/2009-04-15.json
|
||||
botocore/data/aws/ses/2010-12-01.json
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
six>=1.1.0
|
||||
jmespath==0.4.1
|
||||
python-dateutil>=2.1
|
||||
python-dateutil>=2.1
|
||||
|
|
@ -16,7 +16,7 @@ import os
|
|||
import re
|
||||
import logging
|
||||
|
||||
__version__ = '0.55.0'
|
||||
__version__ = '0.62.0'
|
||||
|
||||
|
||||
class NullHandler(logging.Handler):
|
||||
|
|
|
|||
|
|
@ -23,11 +23,14 @@ from operator import itemgetter
|
|||
import functools
|
||||
import time
|
||||
|
||||
|
||||
from botocore.exceptions import NoCredentialsError
|
||||
from botocore.utils import normalize_url_path
|
||||
from botocore.utils import normalize_url_path, percent_encode_sequence
|
||||
from botocore.utils import percent_encode
|
||||
from botocore.compat import HTTPHeaders
|
||||
from botocore.compat import quote, unquote, urlsplit, parse_qs, urlencode
|
||||
from botocore.compat import quote, unquote, urlsplit, parse_qs
|
||||
from botocore.compat import urlunsplit
|
||||
from botocore.compat import encodebytes
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
|
@ -118,7 +121,7 @@ class SigV3Auth(BaseSigner):
|
|||
new_hmac = hmac.new(self.credentials.secret_key.encode('utf-8'),
|
||||
digestmod=sha256)
|
||||
new_hmac.update(request.headers['Date'].encode('utf-8'))
|
||||
encoded_signature = base64.encodestring(new_hmac.digest()).strip()
|
||||
encoded_signature = encodebytes(new_hmac.digest()).strip()
|
||||
signature = ('AWS3-HTTPS AWSAccessKeyId=%s,Algorithm=%s,Signature=%s' %
|
||||
(self.credentials.access_key, 'HmacSHA256',
|
||||
encoded_signature.decode('utf-8')))
|
||||
|
|
@ -254,7 +257,8 @@ class SigV4Auth(BaseSigner):
|
|||
return '\n'.join(cr)
|
||||
|
||||
def _normalize_url_path(self, path):
|
||||
return normalize_url_path(path)
|
||||
normalized_path = quote(normalize_url_path(path), safe='/~')
|
||||
return normalized_path
|
||||
|
||||
def scope(self, args):
|
||||
scope = [self.credentials.access_key]
|
||||
|
|
@ -378,7 +382,7 @@ class SigV4QueryAuth(SigV4Auth):
|
|||
# You can't mix the two types of params together, i.e just keep doing
|
||||
# new_query_params.update(op_params)
|
||||
# new_query_params.update(auth_params)
|
||||
# urlencode(new_query_params)
|
||||
# percent_encode_sequence(new_query_params)
|
||||
operation_params = ''
|
||||
if request.data:
|
||||
# We also need to move the body params into the query string.
|
||||
|
|
@ -388,8 +392,9 @@ class SigV4QueryAuth(SigV4Auth):
|
|||
query_dict.update(request.data)
|
||||
request.data = ''
|
||||
if query_dict:
|
||||
operation_params = urlencode(query_dict) + '&'
|
||||
new_query_string = operation_params + urlencode(auth_params)
|
||||
operation_params = percent_encode_sequence(query_dict) + '&'
|
||||
new_query_string = operation_params + \
|
||||
percent_encode_sequence(auth_params)
|
||||
# url_parts is a tuple (and therefore immutable) so we need to create
|
||||
# a new url_parts with the new query string.
|
||||
# <part> - <index>
|
||||
|
|
@ -452,7 +457,7 @@ class HmacV1Auth(BaseSigner):
|
|||
new_hmac = hmac.new(self.credentials.secret_key.encode('utf-8'),
|
||||
digestmod=sha1)
|
||||
new_hmac.update(string_to_sign.encode('utf-8'))
|
||||
return base64.encodestring(new_hmac.digest()).strip().decode('utf-8')
|
||||
return encodebytes(new_hmac.digest()).strip().decode('utf-8')
|
||||
|
||||
def canonical_standard_headers(self, headers):
|
||||
interesting_headers = ['content-md5', 'content-type', 'date']
|
||||
|
|
|
|||
|
|
@ -33,6 +33,7 @@ if six.PY3:
|
|||
from urllib.parse import urlencode
|
||||
from http.client import HTTPResponse
|
||||
from io import IOBase as _IOBase
|
||||
from base64 import encodebytes
|
||||
file_type = _IOBase
|
||||
zip = zip
|
||||
|
||||
|
|
@ -69,6 +70,7 @@ else:
|
|||
file_type = file
|
||||
from itertools import izip as zip
|
||||
from httplib import HTTPResponse
|
||||
from base64 import encodestring as encodebytes
|
||||
|
||||
class HTTPHeaders(Message):
|
||||
|
||||
|
|
|
|||
|
|
@ -226,6 +226,16 @@ class CredentialProvider(object):
|
|||
"""
|
||||
return True
|
||||
|
||||
def _extract_creds_from_mapping(self, mapping, *key_names):
|
||||
found = []
|
||||
for key_name in key_names:
|
||||
try:
|
||||
found.append(mapping[key_name])
|
||||
except KeyError:
|
||||
raise PartialCredentialsError(provider=self.METHOD,
|
||||
cred_var=key_name)
|
||||
return found
|
||||
|
||||
|
||||
class InstanceMetadataProvider(CredentialProvider):
|
||||
METHOD = 'iam-role'
|
||||
|
|
@ -302,8 +312,9 @@ class EnvProvider(CredentialProvider):
|
|||
"""
|
||||
if self._mapping['access_key'] in self.environ:
|
||||
logger.info('Found credentials in environment variables.')
|
||||
access_key = self.environ[self._mapping['access_key']]
|
||||
secret_key = self.environ[self._mapping['secret_key']]
|
||||
access_key, secret_key = self._extract_creds_from_mapping(
|
||||
self.environ, self._mapping['access_key'],
|
||||
self._mapping['secret_key'])
|
||||
token = self._get_session_token()
|
||||
return Credentials(access_key, secret_key, token,
|
||||
method=self.METHOD)
|
||||
|
|
@ -377,8 +388,8 @@ class SharedCredentialProvider(CredentialProvider):
|
|||
if self.ACCESS_KEY in config:
|
||||
logger.info("Found credentials in shared credentials file: %s",
|
||||
self._creds_filename)
|
||||
access_key = config[self.ACCESS_KEY]
|
||||
secret_key = config[self.SECRET_KEY]
|
||||
access_key, secret_key = self._extract_creds_from_mapping(
|
||||
config, self.ACCESS_KEY, self.SECRET_KEY)
|
||||
token = self._get_session_token(config)
|
||||
return Credentials(access_key, secret_key, token,
|
||||
method=self.METHOD)
|
||||
|
|
@ -429,8 +440,8 @@ class ConfigProvider(CredentialProvider):
|
|||
if self.ACCESS_KEY in profile_config:
|
||||
logger.info("Credentials found in config file: %s",
|
||||
self._config_filename)
|
||||
access_key = profile_config[self.ACCESS_KEY]
|
||||
secret_key = profile_config[self.SECRET_KEY]
|
||||
access_key, secret_key = self._extract_creds_from_mapping(
|
||||
profile_config, self.ACCESS_KEY, self.SECRET_KEY)
|
||||
token = self._get_session_token(profile_config)
|
||||
return Credentials(access_key, secret_key, token,
|
||||
method=self.METHOD)
|
||||
|
|
@ -478,8 +489,8 @@ class BotoProvider(CredentialProvider):
|
|||
if self.ACCESS_KEY in credentials:
|
||||
logger.info("Found credentials in boto config file: %s",
|
||||
filename)
|
||||
access_key = credentials[self.ACCESS_KEY]
|
||||
secret_key = credentials[self.SECRET_KEY]
|
||||
access_key, secret_key = self._extract_creds_from_mapping(
|
||||
credentials, self.ACCESS_KEY, self.SECRET_KEY)
|
||||
return Credentials(access_key, secret_key,
|
||||
method=self.METHOD)
|
||||
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@
|
|||
]
|
||||
},
|
||||
{
|
||||
"uri":"https://queue.{region}.amazonaws.com.cn",
|
||||
"uri":"https://{region}.queue.amazonaws.com.cn",
|
||||
"constraints":[
|
||||
["region", "startsWith", "cn-"]
|
||||
]
|
||||
|
|
|
|||
|
|
@ -41,7 +41,57 @@
|
|||
},
|
||||
"output": null,
|
||||
"errors": [],
|
||||
"documentation": "\n <p>\n Attaches one or more Amazon EC2 instances to an existing Auto Scaling group. \n After the instance(s) is attached, it becomes a part of the Auto Scaling group.\n </p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-instance-asg.html\">Attach Amazon EC2 Instance(s) to Your Existing Auto Scaling Group</a>\n in the <i>Auto Scaling Developer Guide</i>.</p>\n "
|
||||
"documentation": "\n <p>\n Attaches one or more Amazon EC2 instances to an existing Auto Scaling group. \n After the instance(s) is attached, it becomes a part of the Auto Scaling group.\n </p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-instance-asg.html\">Attach Amazon EC2 Instances to Your Existing Auto Scaling Group</a>\n in the <i>Auto Scaling Developer Guide</i>.</p>\n "
|
||||
},
|
||||
"CompleteLifecycleAction": {
|
||||
"name": "CompleteLifecycleAction",
|
||||
"input": {
|
||||
"shape_name": "CompleteLifecycleActionType",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"LifecycleHookName": {
|
||||
"shape_name": "AsciiStringMaxLen255",
|
||||
"type": "string",
|
||||
"pattern": "[A-Za-z0-9\\-_\\/]+",
|
||||
"min_length": 1,
|
||||
"max_length": 255,
|
||||
"documentation": "\n\t\t<p>The name of the lifecycle hook.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"AutoScalingGroupName": {
|
||||
"shape_name": "ResourceName",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 1600,
|
||||
"documentation": "\n\t\t<p>The name of the Auto Scaling group to which the lifecycle hook belongs.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"LifecycleActionToken": {
|
||||
"shape_name": "LifecycleActionToken",
|
||||
"type": "string",
|
||||
"min_length": 36,
|
||||
"max_length": 36,
|
||||
"documentation": "\n\t\t<p>A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the \n\t\tlifecycle hook.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"LifecycleActionResult": {
|
||||
"shape_name": "LifecycleActionResult",
|
||||
"type": "string",
|
||||
"documentation": "\n\t\t<p>The action the Auto Scaling group should take. The value for this parameter can \n\t\tbe either <code>CONTINUE</code> or <code>ABANDON</code>.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CompleteLifecycleActionAnswer",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n<p>The output of the <a>CompleteLifecycleAction</a>. </p>\n "
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "\n\t\t<p>Completes the lifecycle action for the associated token initiated under the given lifecycle hook with the specified result. </p>\n\t\t\t\t<p>\n\t\t\tThis operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:\n\t\t</p>\n\t\t<ol>\n\t\t\t<li>\n\t\t\t\tCreate a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.\n\t\t\t</li>\n\t\t\t<li>\n\t\t\t\tCreate an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.\n\t\t\t</li>\n\t\t\t<li>\n\t\t\t\tCreate the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.\n\t\t\t</li>\n\t\t\t<li>\n\t\t\t\tIf necessary, record the lifecycle action heartbeat to keep the instance in a pending state.\n\t\t\t</li>\n\t\t\t<li>\n\t\t\t\t<b>Complete the lifecycle action.</b>\n\t\t\t</li>\n\t\t</ol>\n\t\t<p>To learn more, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingPendingState.html\">Auto Scaling Pending State</a> and \n\t\t<a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingTerminatingState.html\">Auto Scaling Terminating State</a>.</p>\n\t"
|
||||
},
|
||||
"CreateAutoScalingGroup": {
|
||||
"name": "CreateAutoScalingGroup",
|
||||
|
|
@ -121,7 +171,7 @@
|
|||
"max_length": 255,
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "\n <p> A list of existing Elastic Load Balancing load balancers to use. The load balancers must be associated with the AWS account. </p>\n <p>For information on using load balancers, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SetUpASLBApp.html\">Use Load Balancer to Load Balance Your Auto Scaling Group</a>\n in the <i>Auto Scaling Developer Guide</i>.</p>\n \n "
|
||||
"documentation": "\n <p> A list of existing Elastic Load Balancing load balancers to use. The load balancers must be associated with the AWS account. </p>\n <p>For information on using load balancers, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SetUpASLBApp.html\">Load Balance Your Auto Scaling Group</a>\n in the <i>Auto Scaling Developer Guide</i>.</p>\n \n "
|
||||
},
|
||||
"HealthCheckType": {
|
||||
"shape_name": "XmlStringMaxLen32",
|
||||
|
|
@ -134,7 +184,7 @@
|
|||
"HealthCheckGracePeriod": {
|
||||
"shape_name": "HealthCheckGracePeriod",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>Length of time in seconds after a new Amazon EC2\n instance comes into service that Auto Scaling\n starts checking its health. During this time any health check failure for the that instance is ignored.</p>\n <p>This is required if you are adding <code>ELB</code> health check. Frequently, new instances need to warm up, briefly, \n before they can pass a health check. To provide ample warm-up time, set the health check grace period of the group to \n match the expected startup period of your application.</p>\n \n "
|
||||
"documentation": "\n <p>Length of time in seconds after a new Amazon EC2\n instance comes into service that Auto Scaling\n starts checking its health. During this time any health check failure for the that instance is ignored.</p>\n <p>This is required if you are adding <code>ELB</code> health check. Frequently, new instances need to warm up, briefly, \n before they can pass a health check. To provide ample warm-up time, set the health check grace period of the group to \n match the expected startup period of your application.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-add-elb-healthcheck.html#as-add-elb-healthcheck-api\">Add an Elastic Load Balancing Health Check</a>.</p> \n "
|
||||
},
|
||||
"PlacementGroup": {
|
||||
"shape_name": "XmlStringMaxLen255",
|
||||
|
|
@ -150,7 +200,7 @@
|
|||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 255,
|
||||
"documentation": "\n <p>A comma-separated list of subnet identifiers of Amazon Virtual Private Clouds (Amazon VPCs).</p>\n <p>If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones \n match the Availability Zones specified.\n </p>\n <p>For information on launching your Auto Scaling group into Amazon VPC subnets, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/autoscalingsubnets.html\">Launch Auto Scaling Instances into Amazon VPC</a>\n in the <i>Auto Scaling Developer Guide</i>\n .</p>\n "
|
||||
"documentation": "\n <p>A comma-separated list of subnet identifiers of Amazon Virtual Private Clouds (Amazon VPCs).</p>\n <p>If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones \n match the Availability Zones specified.\n </p>\n <p>For information on launching your Auto Scaling group into Amazon VPC subnets, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/autoscalingsubnets.html\">Auto Scaling in Amazon Virtual Private Cloud</a>\n in the <i>Auto Scaling Developer Guide</i>\n .</p>\n "
|
||||
},
|
||||
"TerminationPolicies": {
|
||||
"shape_name": "TerminationPolicies",
|
||||
|
|
@ -440,7 +490,7 @@
|
|||
"AssociatePublicIpAddress": {
|
||||
"shape_name": "AssociatePublicIpAddress",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Used for Auto Scaling groups that launch instances into an Amazon Virtual Private Cloud (Amazon VPC). Specifies whether to assign a public IP address to each instance launched in a Amazon VPC.</p> \n <note>\n <p>If you specify a value for this parameter, be sure to specify at least one VPC subnet \n using the <i>VPCZoneIdentifier</i> parameter when you create your Auto Scaling group. </p>\n </note> \n <p>Default: If the instance is launched into a default subnet in a default VPC, the default is <code>true</code>. \n If the instance is launched into a nondefault subnet in a VPC, the default is <code>false</code>. \n For information about the platforms supported by Auto Scaling, see \n <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_BasicSetup.html\">Get Started with Auto Scaling Using the Command Line Interface</a>.</p>\n "
|
||||
"documentation": "\n <p>Used for Auto Scaling groups that launch instances into an Amazon Virtual Private Cloud (Amazon VPC). \n Specifies whether to assign a public IP address to each instance launched in a Amazon VPC. For more information, see \n <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/autoscalingsubnets.html\">Auto Scaling in Amazon Virtual Private Cloud</a>.</p> \n <note>\n <p>If you specify a value for this parameter, be sure to specify at least one VPC subnet \n using the <i>VPCZoneIdentifier</i> parameter when you create your Auto Scaling group. </p>\n </note> \n <p>Default: If the instance is launched into a default subnet in a default VPC, the default is <code>true</code>. \n If the instance is launched into a nondefault subnet in a VPC, the default is <code>false</code>. \n For information about default VPC and VPC platforms, see \n <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide//as-supported-platforms.html\">Supported Platforms</a>.</p>\n "
|
||||
},
|
||||
"PlacementTenancy": {
|
||||
"shape_name": "XmlStringMaxLen64",
|
||||
|
|
@ -448,7 +498,7 @@
|
|||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 64,
|
||||
"documentation": "\n <p>The tenancy of the instance. An instance with a tenancy of <code>dedicated</code> runs on single-tenant hardware and can only be launched into a VPC.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/autoscalingsubnets.html\">Auto Scaling in Amazon Virtual Private Cloud</a> in the <i>Auto Scaling Developer Guide</i>. </p>\n <p>Valid values: <code>default</code> | <code>dedicated</code></p>\n \n "
|
||||
"documentation": "\n <p>The tenancy of the instance. An instance with a tenancy of <code>dedicated</code> runs on single-tenant hardware and can only be launched in a VPC.</p>\n <p>You must set the value of this parameter to <code>dedicated</code> if want to launch Dedicated Instances in a shared tenancy VPC (VPC with instance placement tenancy attribute set to <code>default</code>).</p>\n <p>If you specify a value for this parameter, be sure to specify at least one VPC subnet \n using the <i>VPCZoneIdentifier</i> parameter when you create your Auto Scaling group. </p>\n \n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/autoscalingsubnets.html\">Auto Scaling in Amazon Virtual Private Cloud</a>\n in the <i>Auto Scaling Developer Guide</i>. </p>\n \n <p>Valid values: <code>default</code> | <code>dedicated</code></p>\n \n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>\n\n </p>\n "
|
||||
|
|
@ -486,7 +536,7 @@
|
|||
"documentation": "\n <p>\n The quota for capacity groups or launch configurations\n for this customer has already been reached.\n </p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>\n Creates a new launch configuration. The launch configuration name \n must be unique within the scope of the client's AWS account. The maximum limit\n of launch configurations, which by default is 100, must not yet have been met; otherwise, \n the call will fail. When created, the new launch configuration \n is available for immediate use.\n </p> \n \n <examples> \n <queryrequest>https://autoscaling.amazonaws.com/?LaunchConfigurationName=my-test-lc\n&AssociatePublicIpAddress=true\n&ImageId=ami-0078da69\n&InstanceType=m1.small\n&Action=CreateLaunchConfiguration\n&AUTHPARAMS </queryrequest> \n <queryresponse><CreateLaunchConfigurationResponse xmlns=\"http://autoscaling.amazonaws.com/doc/2011-01-01/\">\n<ResponseMetadata>\n <RequestId>7c6e177f-f082-11e1-ac58-3714bEXAMPLE</RequestId>\n</ResponseMetadata>\n</CreateLaunchConfigurationResponse> </queryresponse>\n </examples> \n "
|
||||
"documentation": "\n <p>\n Creates a new launch configuration. The launch configuration name \n must be unique within the scope of the client's AWS account. The maximum limit\n of launch configurations, which by default is 100, must not yet have been met; otherwise, \n the call will fail. When created, the new launch configuration \n is available for immediate use.\n </p> \n \n <examples> \n <queryrequest>https://autoscaling.amazonaws.com/?LaunchConfigurationName=my-test-lc\n&AssociatePublicIpAddress=true\n&PlacementTenancy=dedicated\n&ImageId=ami-0078da69\n&InstanceType=m1.small\n&Action=CreateLaunchConfiguration\n&AUTHPARAMS </queryrequest> \n <queryresponse><CreateLaunchConfigurationResponse xmlns=\"http://autoscaling.amazonaws.com/doc/2011-01-01/\">\n<ResponseMetadata>\n <RequestId>7c6e177f-f082-11e1-ac58-3714bEXAMPLE</RequestId>\n</ResponseMetadata>\n</CreateLaunchConfigurationResponse> </queryresponse>\n </examples> \n "
|
||||
},
|
||||
"CreateOrUpdateTags": {
|
||||
"name": "CreateOrUpdateTags",
|
||||
|
|
@ -597,7 +647,7 @@
|
|||
"ForceDelete": {
|
||||
"shape_name": "ForceDelete",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Starting with API version 2011-01-01, specifies that the Auto Scaling group will be deleted along with all instances \n associated with the group, without waiting for all instances to be terminated. \n </p>\n "
|
||||
"documentation": "\n <p>Starting with API version 2011-01-01, specifies that the Auto Scaling group will be deleted along with all instances \n associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions \n\t\t associated with the group.\n </p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>\n\n </p>\n "
|
||||
|
|
@ -675,6 +725,42 @@
|
|||
],
|
||||
"documentation": "\n <p>\n Deletes the specified <a>LaunchConfiguration</a>.\n </p>\n <p>\n The specified launch configuration must not be \n attached to an Auto Scaling group. When this call completes,\n the launch configuration is no longer available for use.\n </p>\n <examples> \n <queryrequest>https://autoscaling.amazonaws.com/?LaunchConfigurationName=my-test-lc\n&Version=2011-01-01\n&Action=DeleteLaunchConfiguration\n&AUTHPARAMS </queryrequest> \n <queryresponse><DeleteLaunchConfigurationResponse xmlns=\"http://autoscaling.amazonaws.com/doc/2011-01-01/\">\n <ResponseMetadata>\n <RequestId>7347261f-97df-11e2-8756-35eEXAMPLE</RequestId>\n </ResponseMetadata>\n</DeleteLaunchConfigurationResponse> </queryresponse>\n </examples> \n \n "
|
||||
},
|
||||
"DeleteLifecycleHook": {
|
||||
"name": "DeleteLifecycleHook",
|
||||
"input": {
|
||||
"shape_name": "DeleteLifecycleHookType",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"LifecycleHookName": {
|
||||
"shape_name": "AsciiStringMaxLen255",
|
||||
"type": "string",
|
||||
"pattern": "[A-Za-z0-9\\-_\\/]+",
|
||||
"min_length": 1,
|
||||
"max_length": 255,
|
||||
"documentation": "\n\t\t<p>The name of the lifecycle hook.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"AutoScalingGroupName": {
|
||||
"shape_name": "ResourceName",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 1600,
|
||||
"documentation": "\n\t\t<p>The name of the Auto Scaling group to which the lifecycle hook belongs.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n \n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "DeleteLifecycleHookAnswer",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The output of the <a>DeleteLifecycleHook</a> action. </p>\n "
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "\n\t\t<p>Deletes the specified lifecycle hook. If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).</p>\n "
|
||||
},
|
||||
"DeleteNotificationConfiguration": {
|
||||
"name": "DeleteNotificationConfiguration",
|
||||
"input": {
|
||||
|
|
@ -1048,10 +1134,18 @@
|
|||
"type": "string",
|
||||
"enum": [
|
||||
"Pending",
|
||||
"Pending:Wait",
|
||||
"Pending:Proceed",
|
||||
"Quarantined",
|
||||
"InService",
|
||||
"Terminating",
|
||||
"Terminated"
|
||||
"Terminating:Wait",
|
||||
"Terminating:Proceed",
|
||||
"Terminated",
|
||||
"Detaching",
|
||||
"Detached",
|
||||
"EnteringStandby",
|
||||
"Standby"
|
||||
],
|
||||
"documentation": "\n <p>\n Contains a description of the current <i>lifecycle</i> state. \n </p>\n <note>\n <p>The <code>Quarantined</code> lifecycle state is currently not used.</p>\n </note>\n ",
|
||||
"required": true
|
||||
|
|
@ -1393,7 +1487,7 @@
|
|||
"documentation": "\n <p>\n The <code>NextToken</code> value is invalid.\n </p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>\n Returns a description of each Auto Scaling instance in the <code>InstanceIds</code> list.\n If a list is not provided, the service returns the full details of all instances up to a maximum of 50. \n By default, the service returns a list of 20 items.\n </p>\n <p>\n This action supports pagination by returning a token if there are more pages to retrieve.\n To get the next page, call this action again with the returned token as the <code>NextToken</code> parameter.\n </p>\n <examples> \n <queryrequest>https://autoscaling.amazonaws.com/?MaxRecords=20\n&InstanceIds.member.1=i-78e0d40b\n&Version=2011-01-01\n&Action=DescribeAutoScalingInstances\n&AUTHPARAMS </queryrequest> \n <queryresponse><DescribeAutoScalingInstancesResponse xmlns=\"http://autoscaling.amazonaws.com/doc/2011-01-01/\">\n <DescribeAutoScalingInstancesResult>\n <AutoScalingInstances>\n <member>\n <HealthStatus>HEALTHY</HealthStatus>\n <AutoScalingGroupName>my-test-asg</AutoScalingGroupName>\n <AvailabilityZone>us-east-1e</AvailabilityZone>\n <InstanceId>i-78e0d40b</InstanceId>\n <LaunchConfigurationName>my-test-lc</LaunchConfigurationName>\n <LifecycleState>InService</LifecycleState>\n </member>\n </AutoScalingInstances>\n </DescribeAutoScalingInstancesResult>\n <ResponseMetadata>\n <RequestId>df992dc3-b72f-11e2-81e1-750aa6EXAMPLE</RequestId>\n </ResponseMetadata>\n</DescribeAutoScalingInstancesResponse>\n </queryresponse>\n </examples> \n \n ",
|
||||
"documentation": "\n <p>\n Returns a description of each Auto Scaling instance in the <code>InstanceIds</code> list.\n If a list is not provided, the service returns the full details of all instances up to a maximum of 50. \n By default, the service returns a list of 20 items.\n </p>\n <p>\n This action supports pagination by returning a token if there are more pages to retrieve.\n To get the next page, call this action again with the returned token as the <code>NextToken</code> parameter.\n </p>\n <examples> \n <queryrequest>https://autoscaling.amazonaws.com/?MaxRecords=20\n&InstanceIds.member.1=i-78e0d40b\n&Version=2011-01-01\n&Action=DescribeAutoScalingInstances\n&AUTHPARAMS </queryrequest> \n <queryresponse><DescribeAutoScalingInstancesResponse xmlns=\"http://autoscaling.amazonaws.com/doc/2011-01-01/\">\n <DescribeAutoScalingInstancesResult>\n <AutoScalingInstances>\n <member>\n <HealthStatus>Healthy</HealthStatus>\n <AutoScalingGroupName>my-test-asg</AutoScalingGroupName>\n <AvailabilityZone>us-east-1e</AvailabilityZone>\n <InstanceId>i-78e0d40b</InstanceId>\n <LaunchConfigurationName>my-test-lc</LaunchConfigurationName>\n <LifecycleState>InService</LifecycleState>\n </member>\n </AutoScalingInstances>\n </DescribeAutoScalingInstancesResult>\n <ResponseMetadata>\n <RequestId>df992dc3-b72f-11e2-81e1-750aa6EXAMPLE</RequestId>\n </ResponseMetadata>\n</DescribeAutoScalingInstancesResponse>\n </queryresponse>\n </examples> \n \n ",
|
||||
"pagination": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
|
|
@ -1716,6 +1810,145 @@
|
|||
"py_input_token": "next_token"
|
||||
}
|
||||
},
|
||||
"DescribeLifecycleHookTypes": {
|
||||
"name": "DescribeLifecycleHookTypes",
|
||||
"input": null,
|
||||
"output": {
|
||||
"shape_name": "DescribeLifecycleHookTypesAnswer",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"LifecycleHookTypes": {
|
||||
"shape_name": "AutoScalingNotificationTypes",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "XmlStringMaxLen255",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 255,
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "\n\t\t<p>Returns a list of all notification types supported by Auto Scaling. They are:</p> \n <ul>\n <li><p><code>autoscaling:EC2_INSTANCE_LAUNCHING</code></p></li>\n <li><p><code>autoscaling:EC2_INSTANCE_TERMINATING</code></p></li> \n </ul>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n\n "
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "\n\t\t<p>Describes the available types of lifecycle hooks.</p>\n "
|
||||
},
|
||||
"DescribeLifecycleHooks": {
|
||||
"name": "DescribeLifecycleHooks",
|
||||
"input": {
|
||||
"shape_name": "DescribeLifecycleHooksType",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"AutoScalingGroupName": {
|
||||
"shape_name": "ResourceName",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 1600,
|
||||
"documentation": "\n\t\t\t<p>The name of one or more Auto Scaling groups.</p>\n\t ",
|
||||
"required": true
|
||||
},
|
||||
"LifecycleHookNames": {
|
||||
"shape_name": "LifecycleHookNames",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "AsciiStringMaxLen255",
|
||||
"type": "string",
|
||||
"pattern": "[A-Za-z0-9\\-_\\/]+",
|
||||
"min_length": 1,
|
||||
"max_length": 255,
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "\n\t\t\t<p>The name of one or more lifecycle hooks.</p>\n\t "
|
||||
}
|
||||
},
|
||||
"documentation": "\n \n\t\t"
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "DescribeLifecycleHooksAnswer",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"LifecycleHooks": {
|
||||
"shape_name": "LifecycleHooks",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "LifecycleHook",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"LifecycleHookName": {
|
||||
"shape_name": "AsciiStringMaxLen255",
|
||||
"type": "string",
|
||||
"pattern": "[A-Za-z0-9\\-_\\/]+",
|
||||
"min_length": 1,
|
||||
"max_length": 255,
|
||||
"documentation": "\n\t\t<p>\n\t\t\tThe name of the lifecycle action hook.\n\t\t</p>\n "
|
||||
},
|
||||
"AutoScalingGroupName": {
|
||||
"shape_name": "ResourceName",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 1600,
|
||||
"documentation": "\n\t\t<p>\n\t\t\tThe name of the Auto Scaling group to which the lifecycle action belongs.\n\t\t</p>\n "
|
||||
},
|
||||
"LifecycleTransition": {
|
||||
"shape_name": "LifecycleTransition",
|
||||
"type": "string",
|
||||
"documentation": "\n\t\t<p>The Amazon EC2 instance state to which you want to attach the lifecycle hook. See <a>DescribeLifecycleHooks</a> for a list of available lifecycle hook types.</p>\n "
|
||||
},
|
||||
"NotificationTargetARN": {
|
||||
"shape_name": "ResourceName",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 1600,
|
||||
"documentation": "\n\t\t<p>The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either \n\t\tan SQS queue or an SNS topic. The notification message sent to the target will include:</p>\n\t\t<ul>\n\t\t\t<li>Lifecycle action token</li>\n\t\t\t<li>User account ID</li>\n\t\t\t<li>Name of the Auto Scaling group</li>\n\t\t\t<li>Lifecycle hook name</li>\n\t\t\t<li>EC2 instance ID</li>\n\t\t\t<li>Lifecycle transition</li>\n\t\t\t<li>Notification metadata</li>\n\t\t</ul>\n "
|
||||
},
|
||||
"RoleARN": {
|
||||
"shape_name": "ResourceName",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 1600,
|
||||
"documentation": "\n\t\t<p>The ARN of the Amazon IAM role that allows the Auto Scaling group to publish to the specified notification target.</p>\n "
|
||||
},
|
||||
"NotificationMetadata": {
|
||||
"shape_name": "XmlStringMaxLen1023",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 1023,
|
||||
"documentation": "\n\t\t<p>Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.</p>\n "
|
||||
},
|
||||
"HeartbeatTimeout": {
|
||||
"shape_name": "HeartbeatTimeout",
|
||||
"type": "integer",
|
||||
"documentation": "\n\t\t<p>Defines the amount of time that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the \n\t\t<code>DefaultResult</code> parameter. You can prevent the lifecycle hook from timing out by calling <a>RecordLifecycleActionHeartbeat</a>.</p>\n "
|
||||
},
|
||||
"GlobalTimeout": {
|
||||
"shape_name": "GlobalTimeout",
|
||||
"type": "integer",
|
||||
"documentation": "\n\t\t<p>The maximum length of time an instance can remain in a <code>Pending:Wait</code> or <code>Terminating:Wait</code> state. Currently, this value is set at 48 hours.</p>\n "
|
||||
},
|
||||
"DefaultResult": {
|
||||
"shape_name": "LifecycleActionResult",
|
||||
"type": "string",
|
||||
"documentation": "\n\t\t<p>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The value for this parameter can \n\t\tbe either <code>CONTINUE</code> or <code>ABANDON</code>. The default value for this parameter is <code>CONTINUE</code>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>\n\t\tA lifecycle hook tells Auto Scaling that you want to perform an action when an instance launches or terminates. When you have a lifecycle hook in place, the Auto Scaling group will either:\n\t\t</p>\n\t\t<ul>\n\t\t\t<li>\n\t\t\t\tPause the instance after it launches, but before it is put into service\n\t\t\t</li>\n\t\t\t<li>\n\t\t\t\tPause the instance as it terminates, but before it is fully terminated\n\t\t\t</li>\n\t\t</ul>\n\t\t<p>To learn more, \n\t\tsee <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingPendingState.html\">Auto Scaling Pending State</a> and \n\t\t<a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingTerminatingState.html\">Auto Scaling Terminating State</a>.</p>\n "
|
||||
},
|
||||
"documentation": "\n\t\t\t<p>\n\t\t\tA list describing the lifecycle hooks that belong to the specified Auto Scaling group.\n\t\t\t</p>\n\t "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The output of the <a>DescribeLifecycleHooks</a> action. </p>\n\t "
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "\n\t\t<p>\n\t\t\tDescribes the lifecycle hooks that currently belong to the specified Auto Scaling group.\n\t\t</p>\n "
|
||||
},
|
||||
"DescribeMetricCollectionTypes": {
|
||||
"name": "DescribeMetricCollectionTypes",
|
||||
"input": null,
|
||||
|
|
@ -1741,7 +1974,7 @@
|
|||
},
|
||||
"documentation": "\n <p>\n The MetricCollectionType data type.\n </p>\n "
|
||||
},
|
||||
"documentation": "\n <p>The list of Metrics collected. The following metrics are supported:\n </p>\n <ul>\n <li><p>GroupMinSize</p></li>\n <li><p>GroupMaxSize</p></li>\n <li><p>GroupDesiredCapacity</p></li>\n <li><p>GroupInServiceInstances</p></li>\n <li><p>GroupPendingInstances</p></li>\n <li><p>GroupTerminatingInstances</p></li>\n <li><p>GroupTotalInstances</p></li>\n </ul>\n\n "
|
||||
"documentation": "\n <p>The list of Metrics collected. The following metrics are supported:\n </p>\n <ul>\n <li><p>GroupMinSize</p></li>\n <li><p>GroupMaxSize</p></li>\n <li><p>GroupDesiredCapacity</p></li>\n <li><p>GroupInServiceInstances</p></li>\n <li><p>GroupPendingInstances</p></li>\n <li><p>GroupStandbyInstances</p></li>\n <li><p>GroupTerminatingInstances</p></li>\n <li><p>GroupTotalInstances</p></li>\n </ul>\n <note>\n <p>The <code>GroupStandbyInstances</code> metric is not returned by default. You must explicitly request it when calling <a>EnableMetricsCollection</a>.</p>\n </note>\n "
|
||||
},
|
||||
"Granularities": {
|
||||
"shape_name": "MetricGranularityTypes",
|
||||
|
|
@ -1767,7 +2000,7 @@
|
|||
"documentation": "\n <p>The output of the <a>DescribeMetricCollectionTypes</a> action.</p>\n "
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "\n <p>\n Returns a list of metrics and a corresponding list \n of granularities for each metric.\n </p>\n <examples> \n <queryrequest>https://autoscaling.amazonaws.com/?Version=2011-01-01&Action=DescribeMetricCollectionTypes\n&AUTHPARAMS </queryrequest> \n <queryresponse><DescribeMetricCollectionTypesResponse xmlns=\"http://autoscaling.amazonaws.co\noc/2011-01-01/\">\n <DescribeMetricCollectionTypesResult>\n <Metrics>\n <member>\n <Metric>GroupMinSize</Metric>\n </member>\n <member>\n <Metric>GroupMaxSize</Metric>\n </member>\n <member>\n <Metric>GroupDesiredCapacity</Metric>\n </member>\n <member>\n <Metric>GroupInServiceInstances</Metric>\n </member>\n <member>\n <Metric>GroupPendingInstances</Metric>\n </member>\n <member>\n <Metric>GroupTerminatingInstances</Metric>\n </member>\n <member>\n <Metric>GroupTotalInstances</Metric>\n </member>\n </Metrics>\n <Granularities>\n <member>\n <Granularity>1Minute</Granularity>\n </member>\n </Granularities>\n </DescribeMetricCollectionTypesResult>\n <ResponseMetadata>\n <RequestId>07f3fea2-bf3c-11e2-9b6f-f3cdbb80c073</RequestId>\n </ResponseMetadata>\n</DescribeMetricCollectionTypesResponse> </queryresponse>\n </examples> \n "
|
||||
"documentation": "\n <p>\n Returns a list of metrics and a corresponding list \n of granularities for each metric.\n </p>\n <examples> \n <queryrequest>https://autoscaling.amazonaws.com/?Version=2011-01-01&Action=DescribeMetricCollectionTypes\n&AUTHPARAMS </queryrequest> \n <queryresponse><DescribeMetricCollectionTypesResponse xmlns=\"http://autoscaling.amazonaws.co\noc/2011-01-01/\">\n <DescribeMetricCollectionTypesResult>\n <Metrics>\n <member>\n <Metric>GroupMinSize</Metric>\n </member>\n <member>\n <Metric>GroupMaxSize</Metric>\n </member>\n <member>\n <Metric>GroupDesiredCapacity</Metric>\n </member>\n <member>\n <Metric>GroupInServiceInstances</Metric>\n </member>\n <member>\n <Metric>GroupPendingInstances</Metric>\n </member>\n <member>\n <Metric>GroupStandyInstances</Metric>\n </member>\n <member>\n <Metric>GroupTerminatingInstances</Metric>\n </member>\n <member>\n <Metric>GroupTotalInstances</Metric>\n </member>\n </Metrics>\n <Granularities>\n <member>\n <Granularity>1Minute</Granularity>\n </member>\n </Granularities>\n </DescribeMetricCollectionTypesResult>\n <ResponseMetadata>\n <RequestId>07f3fea2-bf3c-11e2-9b6f-f3cdbb80c073</RequestId>\n </ResponseMetadata>\n</DescribeMetricCollectionTypesResponse> </queryresponse>\n </examples>\n <note>\n <p>The <code>GroupStandbyInstances</code> metric is not returned by default. You must explicitly request it when calling <a>EnableMetricsCollection</a>.</p>\n </note>\n "
|
||||
},
|
||||
"DescribeNotificationConfigurations": {
|
||||
"name": "DescribeNotificationConfigurations",
|
||||
|
|
@ -2146,6 +2379,8 @@
|
|||
"WaitingForInstanceId",
|
||||
"PreInService",
|
||||
"InProgress",
|
||||
"WaitingForELBConnectionDraining",
|
||||
"MidLifecycleAction",
|
||||
"Successful",
|
||||
"Failed",
|
||||
"Cancelled"
|
||||
|
|
@ -2570,6 +2805,144 @@
|
|||
"errors": [],
|
||||
"documentation": "\n <p>\n Returns a list of all termination policies supported by Auto Scaling. \n </p>\n <examples> \n <queryrequest>https://autoscaling.amazonaws.com/?Version=2011-01-01\n&Action=DescribeTerminationPolicyTypes\n&AUTHPARAMS </queryrequest> \n <queryresponse><DescribeTerminationPolicyTypesResponse xmlns=\"http://autoscaling.amazonaws.com/doc/2011-01-01/\">\n <DescribeTerminationPolicyTypesResult>\n <TerminationPolicyTypes>\n <member>ClosestToNextInstanceHour</member>\n <member>Default</member>\n <member>NewestInstance</member>\n <member>OldestInstance</member>\n <member>OldestLaunchConfiguration</member>\n </TerminationPolicyTypes>\n </DescribeTerminationPolicyTypesResult>\n <ResponseMetadata>\n <RequestId>d9a05827-b735-11e2-a40c-c79a5EXAMPLE</RequestId>\n </ResponseMetadata>\n</DescribeTerminationPolicyTypesResponse> </queryresponse>\n </examples> \n \n "
|
||||
},
|
||||
"DetachInstances": {
|
||||
"name": "DetachInstances",
|
||||
"input": {
|
||||
"shape_name": "DetachInstancesQuery",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"InstanceIds": {
|
||||
"shape_name": "InstanceIds",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "XmlStringMaxLen16",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 16,
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "\n\t\t<p>\n\t\t A list of instances to detach from the Auto Scaling group. You must specify at least one instance ID. \n\t\t</p>\n\t"
|
||||
},
|
||||
"AutoScalingGroupName": {
|
||||
"shape_name": "ResourceName",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 1600,
|
||||
"documentation": "\n\t\t<p>\n\t\t\tThe name of the Auto Scaling group from which to detach instances.\n\t\t</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"ShouldDecrementDesiredCapacity": {
|
||||
"shape_name": "ShouldDecrementDesiredCapacity",
|
||||
"type": "boolean",
|
||||
"documentation": "\n\t\t<p>\n\t\t\tSpecifies if the detached instance should decrement the desired capacity value for the Auto Scaling group. If set to <code>True</code>, the Auto Scaling \n\t\t\tgroup decrements the desired capacity value by the number of instances detached.\n\t\t</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t"
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "DetachInstancesAnswer",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Activities": {
|
||||
"shape_name": "Activities",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Activity",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ActivityId": {
|
||||
"shape_name": "XmlString",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"documentation": "\n <p>\n Specifies the ID of the activity.\n </p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"AutoScalingGroupName": {
|
||||
"shape_name": "XmlStringMaxLen255",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 255,
|
||||
"documentation": "\n <p>\n The name of the Auto Scaling group.\n </p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "XmlString",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"documentation": "\n <p>\n Contains a friendly, more verbose description of the scaling activity.\n </p>\n "
|
||||
},
|
||||
"Cause": {
|
||||
"shape_name": "XmlStringMaxLen1023",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 1023,
|
||||
"documentation": "\n <p>\n Contains the reason the activity was begun.\n </p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"StartTime": {
|
||||
"shape_name": "TimestampType",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>\n Provides the start time of this activity.\n </p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"EndTime": {
|
||||
"shape_name": "TimestampType",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>\n Provides the end time of this activity.\n </p>\n "
|
||||
},
|
||||
"StatusCode": {
|
||||
"shape_name": "ScalingActivityStatusCode",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"WaitingForSpotInstanceRequestId",
|
||||
"WaitingForSpotInstanceId",
|
||||
"WaitingForInstanceId",
|
||||
"PreInService",
|
||||
"InProgress",
|
||||
"WaitingForELBConnectionDraining",
|
||||
"MidLifecycleAction",
|
||||
"Successful",
|
||||
"Failed",
|
||||
"Cancelled"
|
||||
],
|
||||
"documentation": "\n <p>\n Contains the current status of the activity.\n </p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"StatusMessage": {
|
||||
"shape_name": "XmlStringMaxLen255",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 255,
|
||||
"documentation": "\n <p>\n Contains a friendly, more verbose description of the activity status.\n </p>\n "
|
||||
},
|
||||
"Progress": {
|
||||
"shape_name": "Progress",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>\n Specifies a value between 0 and 100 that indicates the progress of the\n activity.\n </p>\n "
|
||||
},
|
||||
"Details": {
|
||||
"shape_name": "XmlString",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"documentation": "\n <p>\n Contains details of the scaling activity.\n </p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>\n A scaling Activity is a long-running process that \n represents a change to your AutoScalingGroup, \n such as changing the size of the group. \n It can also be a process to replace an instance, \n or a process to perform any other long-running operations \n supported by the API.\n </p>\n "
|
||||
},
|
||||
"documentation": "\n\t\t<p>\n\t\t\tA list describing the activities related to detaching the instances from the Auto Scaling group.\n\t\t</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t<p>The output of the <a>DetachInstances</a> action. </p>\n "
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "\n\t <p>Using <code>DetachInstances</code>, you can remove an instance from an Auto Scaling group. After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.</p>\n\t\t<p>To learn more about detaching instances, \n\t\tsee <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/detach-instance-asg.html\">Detach Amazon EC2 Instances From Your Auto Scaling Group</a>.</p>\n\t <examples> \n\t <queryrequest>https://autoscaling.amazonaws.com/?AutoScalingGroupName=my-asg&ShouldDecrementDesiredCapacity=true&InstanceIds.member.1=i-5f2e8a0d&Version=2011-01-01\n&Action=DetachInstances&SignatureVersion=2&SignatureMethod=HmacSHA256&Timestamp=2014-06-14T00%3A07%3A29.962Z&AUTHPARAMS </queryrequest> \n\t <queryresponse><DetachInstancesResponse xmlns=\"http://autoscaling.amazonaws.com/doc/2011-01-01/\">\n <DetachInstancesResult>\n <Activities>\n <member>\n <ActivityId>e54ff599-bf05-4076-8b95-a0f090ed90bb</ActivityId>\n <Progress>50</Progress>\n <StatusCode>InProgress</StatusCode>\n <StartTime>2014-06-14T00:07:30.280Z</StartTime>\n <Cause>At 2014-06-14T00:07:30Z instance i-5f2e8a0d was detached in response to a user request, shrinking the capacity from 4 to 3.</Cause>\n <AutoScalingGroupName>my-asg</AutoScalingGroupName>\n <Details>{\"Availability Zone\":\"us-east-1a\"}</Details>\n <Description>Detaching EC2 instance: i-5f2e8a0d</Description>\n </member>\n </Activities>\n </DetachInstancesResult>\n <ResponseMetadata>\n <RequestId>e04f3b11-f357-11e3-a434-7f10009d5849</RequestId>\n </ResponseMetadata>\n</DetachInstancesResponse> </queryresponse>\n\t </examples>\n\t"
|
||||
},
|
||||
"DisableMetricsCollection": {
|
||||
"name": "DisableMetricsCollection",
|
||||
"input": {
|
||||
|
|
@ -2596,7 +2969,7 @@
|
|||
"max_length": 255,
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "\n <p>\n The list of metrics to disable.\n If no metrics are specified, all metrics are disabled.\n The following metrics are supported:\n </p>\n <ul>\n <li><p>GroupMinSize</p></li>\n <li><p>GroupMaxSize</p></li>\n <li><p>GroupDesiredCapacity</p></li>\n <li><p>GroupInServiceInstances</p></li>\n <li><p>GroupPendingInstances</p></li>\n <li><p>GroupTerminatingInstances</p></li>\n <li><p>GroupTotalInstances</p></li>\n </ul>\n "
|
||||
"documentation": "\n <p>\n The list of metrics to disable.\n If no metrics are specified, all metrics are disabled.\n The following metrics are supported:\n </p>\n <ul>\n <li><p>GroupMinSize</p></li>\n <li><p>GroupMaxSize</p></li>\n <li><p>GroupDesiredCapacity</p></li>\n <li><p>GroupInServiceInstances</p></li>\n <li><p>GroupPendingInstances</p></li>\n <li><p>GroupStandbyInstances</p></li>\n <li><p>GroupTerminatingInstances</p></li>\n <li><p>GroupTotalInstances</p></li>\n </ul>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n "
|
||||
|
|
@ -2631,7 +3004,7 @@
|
|||
"max_length": 255,
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "\n <p>\n The list of metrics to collect.\n If no metrics are specified, all metrics are enabled.\n The following metrics are supported:\n </p>\n <ul>\n <li><p>GroupMinSize</p></li>\n <li><p>GroupMaxSize</p></li>\n <li><p>GroupDesiredCapacity</p></li>\n <li><p>GroupInServiceInstances</p></li>\n <li><p>GroupPendingInstances</p></li>\n <li><p>GroupTerminatingInstances</p></li>\n <li><p>GroupTotalInstances</p></li>\n </ul>\n "
|
||||
"documentation": "\n <p>\n The list of metrics to collect.\n If no metrics are specified, all metrics are enabled.\n The following metrics are supported:\n </p>\n <ul>\n <li><p>GroupMinSize</p></li>\n <li><p>GroupMaxSize</p></li>\n <li><p>GroupDesiredCapacity</p></li>\n <li><p>GroupInServiceInstances</p></li>\n <li><p>GroupPendingInstances</p></li>\n <li><p>GroupStandbyInstances</p></li>\n <li><p>GroupTerminatingInstances</p></li>\n <li><p>GroupTotalInstances</p></li>\n </ul>\n <note>\n <p>The <code>GroupStandbyInstances</code> metric is not returned by default. You must explicitly request it when calling <a>EnableMetricsCollection</a>.</p>\n </note>\n "
|
||||
},
|
||||
"Granularity": {
|
||||
"shape_name": "XmlStringMaxLen255",
|
||||
|
|
@ -2649,6 +3022,144 @@
|
|||
"errors": [],
|
||||
"documentation": "\n <p>\n Enables monitoring of group metrics for the\n Auto Scaling group specified in <code>AutoScalingGroupName</code>.\n You can specify the list of enabled metrics with the\n <code>Metrics</code> parameter.\n </p>\n <p>\n Auto Scaling metrics collection can be turned on only \n if the <code>InstanceMonitoring</code> flag, \n in the Auto Scaling group's launch configuration, \n is set to <code>True</code>.\n </p>\n "
|
||||
},
|
||||
"EnterStandby": {
|
||||
"name": "EnterStandby",
|
||||
"input": {
|
||||
"shape_name": "EnterStandbyQuery",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"InstanceIds": {
|
||||
"shape_name": "InstanceIds",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "XmlStringMaxLen16",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 16,
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "\n\t\t<p>\n\t\t The instances to move into Standby mode. You must specify at least one instance ID. \n\t\t</p>\n\t"
|
||||
},
|
||||
"AutoScalingGroupName": {
|
||||
"shape_name": "ResourceName",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 1600,
|
||||
"documentation": "\n\t\t<p>\n\t\t\tThe name of the Auto Scaling group from which to move instances into Standby mode.\n\t\t</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"ShouldDecrementDesiredCapacity": {
|
||||
"shape_name": "ShouldDecrementDesiredCapacity",
|
||||
"type": "boolean",
|
||||
"documentation": "\n\t\t<p>\n\t\t\tSpecifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity. If set, \n\t\t\tthe desired capacity for the Auto Scaling group decrements by the number of instances moved to Standby mode.\n\t\t</p>\n\t",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t"
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "EnterStandbyAnswer",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Activities": {
|
||||
"shape_name": "Activities",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Activity",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ActivityId": {
|
||||
"shape_name": "XmlString",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"documentation": "\n <p>\n Specifies the ID of the activity.\n </p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"AutoScalingGroupName": {
|
||||
"shape_name": "XmlStringMaxLen255",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 255,
|
||||
"documentation": "\n <p>\n The name of the Auto Scaling group.\n </p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "XmlString",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"documentation": "\n <p>\n Contains a friendly, more verbose description of the scaling activity.\n </p>\n "
|
||||
},
|
||||
"Cause": {
|
||||
"shape_name": "XmlStringMaxLen1023",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 1023,
|
||||
"documentation": "\n <p>\n Contains the reason the activity was begun.\n </p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"StartTime": {
|
||||
"shape_name": "TimestampType",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>\n Provides the start time of this activity.\n </p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"EndTime": {
|
||||
"shape_name": "TimestampType",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>\n Provides the end time of this activity.\n </p>\n "
|
||||
},
|
||||
"StatusCode": {
|
||||
"shape_name": "ScalingActivityStatusCode",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"WaitingForSpotInstanceRequestId",
|
||||
"WaitingForSpotInstanceId",
|
||||
"WaitingForInstanceId",
|
||||
"PreInService",
|
||||
"InProgress",
|
||||
"WaitingForELBConnectionDraining",
|
||||
"MidLifecycleAction",
|
||||
"Successful",
|
||||
"Failed",
|
||||
"Cancelled"
|
||||
],
|
||||
"documentation": "\n <p>\n Contains the current status of the activity.\n </p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"StatusMessage": {
|
||||
"shape_name": "XmlStringMaxLen255",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 255,
|
||||
"documentation": "\n <p>\n Contains a friendly, more verbose description of the activity status.\n </p>\n "
|
||||
},
|
||||
"Progress": {
|
||||
"shape_name": "Progress",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>\n Specifies a value between 0 and 100 that indicates the progress of the\n activity.\n </p>\n "
|
||||
},
|
||||
"Details": {
|
||||
"shape_name": "XmlString",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"documentation": "\n <p>\n Contains details of the scaling activity.\n </p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>\n A scaling Activity is a long-running process that \n represents a change to your AutoScalingGroup, \n such as changing the size of the group. \n It can also be a process to replace an instance, \n or a process to perform any other long-running operations \n supported by the API.\n </p>\n "
|
||||
},
|
||||
"documentation": "\n\t\t<p>\n\t\t\tA list describing the activities related to moving instances into Standby mode.\n\t\t</p>\n\t"
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t <p>The output of the <a>EnterStandby</a> action. </p>\n\t"
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "\n\t\t<p>\n\t\t\tMove instances in an Auto Scaling group into a Standby mode.\n\t\t</p>\n\t <p>To learn more about how to put instances into a Standby mode, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingInServiceState.html\">Auto Scaling InService State</a>.</p>\n\t\t\t <examples> \n\t <queryrequest>https://autoscaling.amazonaws.com/?AutoScalingGroupName=my-asg&ShouldDecrementDesiredCapacity=true&InstanceIds.member.1=i-5b73d709&Version=2011-01-01&Action=\nEnterStandby&SignatureVersion=2&SignatureMethod=HmacSHA256&Timestamp=2014-06-13T22%3A35%3A50.567Z&AUTHPARAMS </queryrequest> \n\t <queryresponse><EnterStandbyResponse xmlns=\"http://autoscaling.amazonaws.com/doc/2011-01-01/\">\n <EnterStandbyResult>\n <Activities>\n <member>\n <ActivityId>462b4bc3-ad3b-4e67-a58d-96cd00f02f9e</ActivityId>\n <Progress>50</Progress>\n <StatusCode>InProgress</StatusCode>\n <StartTime>2014-06-13T22:35:50.884Z</StartTime>\n <Cause>At 2014-06-13T22:35:50Z instance i-5b73d709 was moved to standby in response to a user request, shrinking the capacity from 4 to 3.</Cause>\n <AutoScalingGroupName>my-asg</AutoScalingGroupName>\n <Details>{\"Availability Zone\":\"us-east-1a\"}</Details>\n <Description>Moving EC2 instance to Standby: i-5b73d709</Description>\n </member>\n </Activities>\n </EnterStandbyResult>\n <ResponseMetadata>\n <RequestId>126f2f31-f34b-11e3-bc51-b35178f0274f</RequestId>\n </ResponseMetadata>\n</EnterStandbyResponse> </queryresponse>\n\t </examples>\n\t"
|
||||
},
|
||||
"ExecutePolicy": {
|
||||
"name": "ExecutePolicy",
|
||||
"input": {
|
||||
|
|
@ -2700,6 +3211,229 @@
|
|||
],
|
||||
"documentation": "\n <p>Executes the specified policy. </p>\n "
|
||||
},
|
||||
"ExitStandby": {
|
||||
"name": "ExitStandby",
|
||||
"input": {
|
||||
"shape_name": "ExitStandbyQuery",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"InstanceIds": {
|
||||
"shape_name": "InstanceIds",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "XmlStringMaxLen16",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 16,
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "\n\t\t<p>\n\t\t A list of instances to move out of Standby mode. You must specify at least one instance ID. \n\t\t</p>\n\t"
|
||||
},
|
||||
"AutoScalingGroupName": {
|
||||
"shape_name": "ResourceName",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 1600,
|
||||
"documentation": "\n\t\t<p>\n\t\t\tThe name of the Auto Scaling group from which to move instances out of Standby mode.\n\t\t</p>\n\t",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t"
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ExitStandbyAnswer",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Activities": {
|
||||
"shape_name": "Activities",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Activity",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ActivityId": {
|
||||
"shape_name": "XmlString",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"documentation": "\n <p>\n Specifies the ID of the activity.\n </p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"AutoScalingGroupName": {
|
||||
"shape_name": "XmlStringMaxLen255",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 255,
|
||||
"documentation": "\n <p>\n The name of the Auto Scaling group.\n </p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "XmlString",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"documentation": "\n <p>\n Contains a friendly, more verbose description of the scaling activity.\n </p>\n "
|
||||
},
|
||||
"Cause": {
|
||||
"shape_name": "XmlStringMaxLen1023",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 1023,
|
||||
"documentation": "\n <p>\n Contains the reason the activity was begun.\n </p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"StartTime": {
|
||||
"shape_name": "TimestampType",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>\n Provides the start time of this activity.\n </p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"EndTime": {
|
||||
"shape_name": "TimestampType",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>\n Provides the end time of this activity.\n </p>\n "
|
||||
},
|
||||
"StatusCode": {
|
||||
"shape_name": "ScalingActivityStatusCode",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"WaitingForSpotInstanceRequestId",
|
||||
"WaitingForSpotInstanceId",
|
||||
"WaitingForInstanceId",
|
||||
"PreInService",
|
||||
"InProgress",
|
||||
"WaitingForELBConnectionDraining",
|
||||
"MidLifecycleAction",
|
||||
"Successful",
|
||||
"Failed",
|
||||
"Cancelled"
|
||||
],
|
||||
"documentation": "\n <p>\n Contains the current status of the activity.\n </p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"StatusMessage": {
|
||||
"shape_name": "XmlStringMaxLen255",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 255,
|
||||
"documentation": "\n <p>\n Contains a friendly, more verbose description of the activity status.\n </p>\n "
|
||||
},
|
||||
"Progress": {
|
||||
"shape_name": "Progress",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>\n Specifies a value between 0 and 100 that indicates the progress of the\n activity.\n </p>\n "
|
||||
},
|
||||
"Details": {
|
||||
"shape_name": "XmlString",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"documentation": "\n <p>\n Contains details of the scaling activity.\n </p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>\n A scaling Activity is a long-running process that \n represents a change to your AutoScalingGroup, \n such as changing the size of the group. \n It can also be a process to replace an instance, \n or a process to perform any other long-running operations \n supported by the API.\n </p>\n "
|
||||
},
|
||||
"documentation": "\n\t\t<p>A list describing the activities related to moving instances out of Standby mode.</p>\n\t"
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t <p>The output of the <a>ExitStandby</a> action. </p>\n\t"
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "\n\t\t<p>\n\t\t\tMove an instance out of Standby mode.\n\t\t</p>\n\t <p>To learn more about how to put instances that are in a Standby mode back into service, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingInServiceState.html\">Auto Scaling InService State</a>.</p>\n\t\t\t <examples> \n\t <queryrequest>https://autoscaling.amazonaws.com/?InstanceIds.member.1=i-5b73d709&AutoScalingGroupName=my-asg&Version=2011-01-01&Action=ExitStandby&SignatureVersion=2&SignatureMet\nhod=HmacSHA256&Timestamp=2014-06-13T22%3A43%3A53.182Z&AUTHPARAMS </queryrequest> \n\t <queryresponse><ExitStandbyResponse xmlns=\"http://autoscaling.amazonaws.com/doc/2011-01-01/\">\n <ExitStandbyResult>\n <Activities>\n <member>\n <ActivityId>dca4efcf-eea6-4844-8064-cab1fecd1aa2</ActivityId>\n <Progress>30</Progress>\n <StatusCode>PreInService</StatusCode>\n <StartTime>2014-06-13T22:43:53.523Z</StartTime>\n <Cause>At 2014-06-13T22:43:53Z instance i-5b73d709 was moved out of standby in response to a user request, increasing the capacity from 3 to 4.</Cause>\n <AutoScalingGroupName>my-asg</AutoScalingGroupName>\n <Details>{\"Availability Zone\":\"us-east-1a\"}</Details>\n <Description>Moving EC2 instance out of Standby: i-5b73d709</Description>\n </member>\n </Activities>\n </ExitStandbyResult>\n <ResponseMetadata>\n <RequestId>321a11c8-f34c-11e3-a434-7f10009d5849</RequestId>\n </ResponseMetadata>\n</ExitStandbyResponse> </queryresponse>\n\t </examples>\n\t"
|
||||
},
|
||||
"PutLifecycleHook": {
|
||||
"name": "PutLifecycleHook",
|
||||
"input": {
|
||||
"shape_name": "PutLifecycleHookType",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"LifecycleHookName": {
|
||||
"shape_name": "AsciiStringMaxLen255",
|
||||
"type": "string",
|
||||
"pattern": "[A-Za-z0-9\\-_\\/]+",
|
||||
"min_length": 1,
|
||||
"max_length": 255,
|
||||
"documentation": "\n\t\t<p>The name of the lifecycle hook.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"AutoScalingGroupName": {
|
||||
"shape_name": "ResourceName",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 1600,
|
||||
"documentation": "\n\t\t<p>The name of the Auto Scaling group to which you want to assign the lifecycle hook.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"LifecycleTransition": {
|
||||
"shape_name": "LifecycleTransition",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon EC2 instance state to which you want to attach the lifecycle hook. See <a>DescribeLifecycleHookTypes</a> for a list of available lifecycle hook types.</p>\n <note>\n <p>This parameter is required for new lifecycle hooks, but optional when updating existing hooks.</p>\n </note>\n "
|
||||
},
|
||||
"RoleARN": {
|
||||
"shape_name": "ResourceName",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 1600,
|
||||
"documentation": "\n\t\t<p>The ARN of the Amazon IAM role that allows the Auto Scaling group to publish to the specified notification target.</p>\n\t\t<note>\n\t\t\t<p>This parameter is required for new lifecycle hooks, but optional when updating existing hooks.</p>\n\t\t</note>\n "
|
||||
},
|
||||
"NotificationTargetARN": {
|
||||
"shape_name": "ResourceName",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 1600,
|
||||
"documentation": "\n\t\t<p>The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either \n\t\tan SQS queue or an SNS topic. </p>\n\t\t<note>\n\t\t\t<p>This parameter is required for new lifecycle hooks, but optional when updating existing hooks.</p>\n\t\t</note>\n\t\t<p>The notification message sent to the target will include:</p>\n\t\t<ul>\n\t\t\t<li>\n<b>LifecycleActionToken</b>. The Lifecycle action token.</li>\n\t\t\t<li>\n<b>AccountId</b>. The user account ID.</li>\n\t\t\t<li>\n<b>AutoScalingGroupName</b>. The name of the Auto Scaling group.</li>\n\t\t\t<li>\n<b>LifecycleHookName</b>. The lifecycle hook name.</li>\n\t\t\t<li>\n<b>EC2InstanceId</b>. The EC2 instance ID.</li>\n\t\t\t<li>\n<b>LifecycleTransition</b>. The lifecycle transition.</li>\n\t\t\t<li>\n<b>NotificationMetadata</b>. The notification metadata.</li>\n\t\t</ul>\n\t\t<p>This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS \n\t\ttopic.</p>\n\t\t<p>When you call this operation, a test message is sent to the notification target. This test message contains an additional key/value pair: <code>Event:autoscaling:TEST_NOTIFICATION</code>.</p>\n "
|
||||
},
|
||||
"NotificationMetadata": {
|
||||
"shape_name": "XmlStringMaxLen1023",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 1023,
|
||||
"documentation": "\n\t\t<p>Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.</p>\n "
|
||||
},
|
||||
"HeartbeatTimeout": {
|
||||
"shape_name": "HeartbeatTimeout",
|
||||
"type": "integer",
|
||||
"documentation": "\n\t\t<p>Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the \n\t\t<code>DefaultResult</code> parameter. You can prevent the lifecycle hook from timing out by calling <a>RecordLifecycleActionHeartbeat</a>. The default value for this parameter is\n\t\t3600 seconds (1 hour).</p>\n "
|
||||
},
|
||||
"DefaultResult": {
|
||||
"shape_name": "LifecycleActionResult",
|
||||
"type": "string",
|
||||
"documentation": "\n\t\t<p>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The value for this parameter can \n\t\tbe either <code>CONTINUE</code> or <code>ABANDON</code>. The default value for this parameter is <code>ABANDON</code>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "PutLifecycleHookAnswer",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The output of the <a>PutLifecycleHook</a> action. </p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "LimitExceededFault",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "XmlStringMaxLen255",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 255,
|
||||
"documentation": "\n <p>\n\n </p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>\n The quota for capacity groups or launch configurations\n for this customer has already been reached.\n </p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n \t\t<p>Creates or updates a lifecycle hook for an Auto Scaling Group.</p>\n\t\t<p>A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the \n\t\tinstance terminates.</p>\n\t\t<p>\n\t\t\tThis operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:\n\t\t</p>\n\t\t\t\t<ol>\n\t\t\t<li>\n\t\t\t\tCreate a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.\n\t\t\t</li>\n\t\t\t<li>\n\t\t\t\tCreate an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.\n\t\t\t</li>\n\t\t\t<li>\n\t\t\t\t<b>Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.</b>\n\t\t\t</li>\n\t\t\t<li>\n\t\t\t\tIf necessary, record the lifecycle action heartbeat to keep the instance in a pending state.\n\t\t\t</li>\n\t\t\t<li>\n\t\t\t\tComplete the lifecycle action.\n\t\t\t</li>\n\t\t</ol>\n\t\t\n\t\t<p>To learn more, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingPendingState.html\">Auto Scaling Pending State</a> and \n\t\t<a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingTerminatingState.html\">Auto Scaling Terminating State</a>.</p>\n\t\t\t <examples> \n\t <queryrequest>http://autoscaling.amazonaws.com/?RoleARN=arn%3Aaws%3Aiam%3A%3A896650972448%3Arole%2FAutoScaling&AutoScalingGroupName=my-asg&LifecycleHookName=ReadyForSoftwareInst\nall&NotificationTargetARN=arn%3Aaws%3Asqs%3Aus-east-1%3A896650972448%3Alifecyclehookqueue&LifecycleTransition=autoscaling%3AEC2_INSTANCE_LAUNCHING&Version=2011-\n01-01&Action=PutLifecycleHook&SignatureVersion=2&SignatureMethod=HmacSHA256&Timestamp=2014-06-17T17%3A30%3A36.125Z&AUTHPARAMS </queryrequest> \n\t <queryresponse><PutLifecycleHookResponse xmlns=\"http://autoscaling.amazonaws.com/doc/2011-01-01/\">\n <PutLifecycleHookResult/>\n <ResponseMetadata>\n <RequestId>1952f458-f645-11e3-bc51-b35178f0274f</RequestId>\n </ResponseMetadata>\n</PutLifecycleHookResponse> </queryresponse>\n\t </examples>\n "
|
||||
},
|
||||
"PutNotificationConfiguration": {
|
||||
"name": "PutNotificationConfiguration",
|
||||
"input": {
|
||||
|
|
@ -2947,6 +3681,50 @@
|
|||
],
|
||||
"documentation": "\n <p>\n Creates or updates a scheduled scaling action for an Auto Scaling group. \n When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value \n remains unchanged in the affected Auto Scaling group.\n </p>\n <p>For information on creating or updating a scheduled action for your Auto Scaling group, \n see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/schedule_time.html\">Scale Based on a Schedule</a>.</p>\n <note>\n <p>Auto Scaling supports the date and time expressed in \"YYYY-MM-DDThh:mm:ssZ\" format in UTC/GMT only.</p>\n </note>\n <examples>\n <example>\n <name>Schedule based on a specific date and time</name> \n <queryrequest>https://autoscaling.amazonaws.com/?AutoScalingGroupName=my-test-asg\n&ScheduledActionName=ScaleUp\n&StartTime=2013-05-25T08:00:00Z\n&DesiredCapacity=3\n&Version=2011-01-01\n&Action=PutScheduledUpdateGroupAction\n&AUTHPARAMS </queryrequest> \n <queryresponse><PutScheduledUpdateGroupActionResponse xmlns=\"http://autoscaling.amazonaws.com/doc/2011-01-01/\">\n <ResponseMetadata>\n <RequestId>3bc8c9bc-6a62-11e2-8a51-4b8a1EXAMPLE</RequestId>\n </ResponseMetadata>\n </PutScheduledUpdateGroupActionResponse></queryresponse>\n </example> \n <example>\n <name>Recurring Schedule</name> \n <queryrequest>https://autoscaling.amazonaws.com/?AutoScalingGroupName=my-test-asg\n&ScheduledActionName=scaleup-schedule-year\n&Recurrence=\"30 0 1 1,6,12 *\"\n&DesiredCapacity=3\n&Version=2011-01-01\n&Action=PutScheduledUpdateGroupAction\n&AUTHPARAMS </queryrequest> \n <queryresponse><PutScheduledUpdateGroupActionResponse xmlns=\"http://autoscaling.amazonaws.com/doc/2011-01-01/\">\n <ResponseMetadata>\n <RequestId>3bc8c9bc-6a62-11e2-8a51-4b8a1EXAMPLE</RequestId>\n </ResponseMetadata>\n </PutScheduledUpdateGroupActionResponse></queryresponse>\n </example> \n </examples> \n "
|
||||
},
|
||||
"RecordLifecycleActionHeartbeat": {
|
||||
"name": "RecordLifecycleActionHeartbeat",
|
||||
"input": {
|
||||
"shape_name": "RecordLifecycleActionHeartbeatType",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"LifecycleHookName": {
|
||||
"shape_name": "AsciiStringMaxLen255",
|
||||
"type": "string",
|
||||
"pattern": "[A-Za-z0-9\\-_\\/]+",
|
||||
"min_length": 1,
|
||||
"max_length": 255,
|
||||
"documentation": "\n\t\t<p>The name of the lifecycle hook.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"AutoScalingGroupName": {
|
||||
"shape_name": "ResourceName",
|
||||
"type": "string",
|
||||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 1,
|
||||
"max_length": 1600,
|
||||
"documentation": "\n\t\t<p>The name of the Auto Scaling group to which the hook belongs.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"LifecycleActionToken": {
|
||||
"shape_name": "LifecycleActionToken",
|
||||
"type": "string",
|
||||
"min_length": 36,
|
||||
"max_length": 36,
|
||||
"documentation": "\n\t\t<p>A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the \n\t\tlifecycle hook.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": " \n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "RecordLifecycleActionHeartbeatAnswer",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n\t <p>The output of the <a>RecordLifecycleActionHeartbeat</a> action. </p>\n "
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "\n\t\t<p>\n\t\t\tRecords a heartbeat for the lifecycle action associated with a specific token. This extends the timeout by the length of time defined by the <code>HeartbeatTimeout</code> parameter \n\t\t\tof the <a>PutLifecycleHook</a> operation.\n\t\t</p>\n\t\t<p>\n\t\t\tThis operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:\n\t\t</p>\n\t\t<ol>\n\t\t\t<li>\n\t\t\t\tCreate a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.\n\t\t\t</li>\n\t\t\t<li>\n\t\t\t\tCreate an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.\n\t\t\t</li>\n\t\t\t<li>\n\t\t\t\tCreate the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.\n\t\t\t</li>\n\t\t\t<li>\n\t\t\t\t<b>If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.</b>\n\t\t\t</li>\n\t\t\t<li>\n\t\t\t\tComplete the lifecycle action.\n\t\t\t</li>\n\t\t</ol>\n\t\t<p>To learn more, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingPendingState.html\">Auto Scaling Pending State</a> and \n\t\t<a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingTerminatingState.html\">Auto Scaling Terminating State</a>.</p>\n "
|
||||
},
|
||||
"ResumeProcesses": {
|
||||
"name": "ResumeProcesses",
|
||||
"input": {
|
||||
|
|
@ -3185,6 +3963,8 @@
|
|||
"WaitingForInstanceId",
|
||||
"PreInService",
|
||||
"InProgress",
|
||||
"WaitingForELBConnectionDraining",
|
||||
"MidLifecycleAction",
|
||||
"Successful",
|
||||
"Failed",
|
||||
"Cancelled"
|
||||
|
|
|
|||
|
|
@ -5603,18 +5603,12 @@
|
|||
],
|
||||
"documentation": "\n List origin access identities.\n ",
|
||||
"pagination": {
|
||||
"input_token": [
|
||||
"Marker"
|
||||
],
|
||||
"input_token": "Marker",
|
||||
"output_token": "CloudFrontOriginAccessIdentityList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "IsTruncated",
|
||||
"output_token": [
|
||||
"NextMarker"
|
||||
],
|
||||
"result_key": "CloudFrontOriginAccessIdentityList",
|
||||
"py_input_token": [
|
||||
"marker"
|
||||
]
|
||||
"more_results": "CloudFrontOriginAccessIdentityList.IsTruncated",
|
||||
"result_key": "CloudFrontOriginAccessIdentityList.Items",
|
||||
"py_input_token": "marker"
|
||||
}
|
||||
},
|
||||
"ListDistributions": {
|
||||
|
|
@ -6375,18 +6369,12 @@
|
|||
],
|
||||
"documentation": "\n List distributions.\n ",
|
||||
"pagination": {
|
||||
"input_token": [
|
||||
"Marker"
|
||||
],
|
||||
"input_token": "Marker",
|
||||
"output_token": "DistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "IsTruncated",
|
||||
"output_token": [
|
||||
"NextMarker"
|
||||
],
|
||||
"result_key": "DistributionList",
|
||||
"py_input_token": [
|
||||
"marker"
|
||||
]
|
||||
"more_results": "DistributionList.IsTruncated",
|
||||
"result_key": "DistributionList.Items",
|
||||
"py_input_token": "marker"
|
||||
}
|
||||
},
|
||||
"ListInvalidations": {
|
||||
|
|
@ -6536,18 +6524,12 @@
|
|||
],
|
||||
"documentation": "\n List invalidation batches.\n ",
|
||||
"pagination": {
|
||||
"input_token": [
|
||||
"Marker"
|
||||
],
|
||||
"input_token": "Marker",
|
||||
"output_token": "InvalidationList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "IsTruncated",
|
||||
"output_token": [
|
||||
"NextMarker"
|
||||
],
|
||||
"result_key": "InvalidationList",
|
||||
"py_input_token": [
|
||||
"marker"
|
||||
]
|
||||
"more_results": "InvalidationList.IsTruncated",
|
||||
"result_key": "InvalidationList.Items",
|
||||
"py_input_token": "marker"
|
||||
}
|
||||
},
|
||||
"ListStreamingDistributions": {
|
||||
|
|
@ -6771,18 +6753,12 @@
|
|||
],
|
||||
"documentation": "\n List streaming distributions.\n ",
|
||||
"pagination": {
|
||||
"input_token": [
|
||||
"Marker"
|
||||
],
|
||||
"input_token": "Marker",
|
||||
"output_token": "StreamingDistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "IsTruncated",
|
||||
"output_token": [
|
||||
"NextMarker"
|
||||
],
|
||||
"result_key": "StreamingDistributionList",
|
||||
"py_input_token": [
|
||||
"marker"
|
||||
]
|
||||
"more_results": "StreamingDistributionList.IsTruncated",
|
||||
"result_key": "StreamingDistributionList.Items",
|
||||
"py_input_token": "marker"
|
||||
}
|
||||
},
|
||||
"UpdateCloudFrontOriginAccessIdentity": {
|
||||
|
|
@ -9426,60 +9402,36 @@
|
|||
},
|
||||
"pagination": {
|
||||
"ListCloudFrontOriginAccessIdentities": {
|
||||
"input_token": [
|
||||
"Marker"
|
||||
],
|
||||
"input_token": "Marker",
|
||||
"output_token": "CloudFrontOriginAccessIdentityList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "IsTruncated",
|
||||
"output_token": [
|
||||
"NextMarker"
|
||||
],
|
||||
"result_key": "CloudFrontOriginAccessIdentityList",
|
||||
"py_input_token": [
|
||||
"marker"
|
||||
]
|
||||
"more_results": "CloudFrontOriginAccessIdentityList.IsTruncated",
|
||||
"result_key": "CloudFrontOriginAccessIdentityList.Items",
|
||||
"py_input_token": "marker"
|
||||
},
|
||||
"ListDistributions": {
|
||||
"input_token": [
|
||||
"Marker"
|
||||
],
|
||||
"input_token": "Marker",
|
||||
"output_token": "DistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "IsTruncated",
|
||||
"output_token": [
|
||||
"NextMarker"
|
||||
],
|
||||
"result_key": "DistributionList",
|
||||
"py_input_token": [
|
||||
"marker"
|
||||
]
|
||||
"more_results": "DistributionList.IsTruncated",
|
||||
"result_key": "DistributionList.Items",
|
||||
"py_input_token": "marker"
|
||||
},
|
||||
"ListInvalidations": {
|
||||
"input_token": [
|
||||
"Marker"
|
||||
],
|
||||
"input_token": "Marker",
|
||||
"output_token": "InvalidationList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "IsTruncated",
|
||||
"output_token": [
|
||||
"NextMarker"
|
||||
],
|
||||
"result_key": "InvalidationList",
|
||||
"py_input_token": [
|
||||
"marker"
|
||||
]
|
||||
"more_results": "InvalidationList.IsTruncated",
|
||||
"result_key": "InvalidationList.Items",
|
||||
"py_input_token": "marker"
|
||||
},
|
||||
"ListStreamingDistributions": {
|
||||
"input_token": [
|
||||
"Marker"
|
||||
],
|
||||
"input_token": "Marker",
|
||||
"output_token": "StreamingDistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "IsTruncated",
|
||||
"output_token": [
|
||||
"NextMarker"
|
||||
],
|
||||
"result_key": "StreamingDistributionList",
|
||||
"py_input_token": [
|
||||
"marker"
|
||||
]
|
||||
"more_results": "StreamingDistributionList.IsTruncated",
|
||||
"result_key": "StreamingDistributionList.Items",
|
||||
"py_input_token": "marker"
|
||||
}
|
||||
},
|
||||
"retry": {
|
||||
|
|
|
|||
|
|
@ -306,17 +306,17 @@
|
|||
"Synonyms": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias.</p>\n "
|
||||
"documentation": "\n <p>A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms\">Synonyms</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>\n "
|
||||
},
|
||||
"Stopwords": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A JSON array of terms to ignore during indexing and searching. For example, [\"a\", \"an\", \"the\", \"of\"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. </p>\n "
|
||||
"documentation": "\n <p>A JSON array of terms to ignore during indexing and searching. For example, <code>[\"a\", \"an\", \"the\", \"of\"]</code>. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. </p>\n "
|
||||
},
|
||||
"StemmingDictionary": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.</p>\n "
|
||||
"documentation": "\n <p>A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, <code>{\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}</code>. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.</p>\n "
|
||||
},
|
||||
"AlgorithmicStemming": {
|
||||
"shape_name": "AlgorithmicStemming",
|
||||
|
|
@ -410,17 +410,17 @@
|
|||
"Synonyms": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias.</p>\n "
|
||||
"documentation": "\n <p>A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms\">Synonyms</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>\n "
|
||||
},
|
||||
"Stopwords": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A JSON array of terms to ignore during indexing and searching. For example, [\"a\", \"an\", \"the\", \"of\"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. </p>\n "
|
||||
"documentation": "\n <p>A JSON array of terms to ignore during indexing and searching. For example, <code>[\"a\", \"an\", \"the\", \"of\"]</code>. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. </p>\n "
|
||||
},
|
||||
"StemmingDictionary": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.</p>\n "
|
||||
"documentation": "\n <p>A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, <code>{\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}</code>. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.</p>\n "
|
||||
},
|
||||
"AlgorithmicStemming": {
|
||||
"shape_name": "AlgorithmicStemming",
|
||||
|
|
@ -533,7 +533,7 @@
|
|||
"documentation": "\n <p>The request was rejected because it attempted to reference a resource that does not exist.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Configures an analysis scheme for a domain. An analysis scheme defines language-specific text processing options for a <code>text</code> field. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html\" target=\"_blank\">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>\n "
|
||||
"documentation": "\n <p>Configures an analysis scheme that can be applied to a <code>text</code> or <code>text-array</code> field to define language-specific text processing options. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html\" target=\"_blank\">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>\n "
|
||||
},
|
||||
"DefineExpression": {
|
||||
"name": "DefineExpression",
|
||||
|
|
@ -2058,17 +2058,17 @@
|
|||
"Synonyms": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias.</p>\n "
|
||||
"documentation": "\n <p>A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms\">Synonyms</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>\n "
|
||||
},
|
||||
"Stopwords": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A JSON array of terms to ignore during indexing and searching. For example, [\"a\", \"an\", \"the\", \"of\"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. </p>\n "
|
||||
"documentation": "\n <p>A JSON array of terms to ignore during indexing and searching. For example, <code>[\"a\", \"an\", \"the\", \"of\"]</code>. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. </p>\n "
|
||||
},
|
||||
"StemmingDictionary": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.</p>\n "
|
||||
"documentation": "\n <p>A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, <code>{\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}</code>. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.</p>\n "
|
||||
},
|
||||
"AlgorithmicStemming": {
|
||||
"shape_name": "AlgorithmicStemming",
|
||||
|
|
@ -3333,17 +3333,17 @@
|
|||
"Synonyms": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias.</p>\n "
|
||||
"documentation": "\n <p>A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms\">Synonyms</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>\n "
|
||||
},
|
||||
"Stopwords": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A JSON array of terms to ignore during indexing and searching. For example, [\"a\", \"an\", \"the\", \"of\"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. </p>\n "
|
||||
"documentation": "\n <p>A JSON array of terms to ignore during indexing and searching. For example, <code>[\"a\", \"an\", \"the\", \"of\"]</code>. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. </p>\n "
|
||||
},
|
||||
"StemmingDictionary": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.</p>\n "
|
||||
"documentation": "\n <p>A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, <code>{\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}</code>. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.</p>\n "
|
||||
},
|
||||
"AlgorithmicStemming": {
|
||||
"shape_name": "AlgorithmicStemming",
|
||||
|
|
|
|||
|
|
@ -1,7 +1,9 @@
|
|||
{
|
||||
"api_version": "2013-01-01",
|
||||
"type": "rest-json",
|
||||
"service_full_name": "Amazon CloudSearchDomain",
|
||||
"signature_version": "v4",
|
||||
"signing_name": "cloudsearch",
|
||||
"service_full_name": "Amazon CloudSearch Domain",
|
||||
"jsonVersion": "1.1",
|
||||
"endpoint_prefix": "cloudsearchdomain",
|
||||
"xmlnamespace": "http://cloudsearch.amazonaws.com/doc/2013-01-01/",
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
"service_abbreviation": "CloudTrail",
|
||||
"endpoint_prefix": "cloudtrail",
|
||||
"xmlnamespace": "http://cloudtrail.amazonaws.com/doc/2013-11-01/",
|
||||
"documentation": "\n <fullname>AWS Cloud Trail</fullname>\n <p>This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.</p> \n <p>CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.</p>\n \n \n <note>\n As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code \n for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically \n signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services page</a>.\n </note>\n \n \n<p>See the CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.</p>",
|
||||
"documentation": "\n <fullname>AWS CloudTrail</fullname>\n <p>This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.</p> \n <p>CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.</p>\n \n \n <note>\n As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code \n for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically \n signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services page</a>.\n </note>\n \n \n<p>See the CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.</p>",
|
||||
"operations": {
|
||||
"CreateTrail": {
|
||||
"name": "CreateTrail",
|
||||
|
|
@ -19,12 +19,14 @@
|
|||
"Name": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Specifies the name of the trail.</p>\n \n "
|
||||
"documentation": "\n <p>Specifies the name of the trail.</p>\n \n ",
|
||||
"required": true
|
||||
},
|
||||
"S3BucketName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Specifies the name of the Amazon S3 bucket designated for publishing log files.</p>\n "
|
||||
"documentation": "\n <p>Specifies the name of the Amazon S3 bucket designated for publishing log files.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"S3KeyPrefix": {
|
||||
"shape_name": "String",
|
||||
|
|
@ -40,38 +42,6 @@
|
|||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Specifies whether the trail is publishing events from global services such as IAM to the log files. </p>\n "
|
||||
},
|
||||
"trail": {
|
||||
"shape_name": "Trail",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Name of the trail set by calling <a>CreateTrail</a>.</p>\n "
|
||||
},
|
||||
"S3BucketName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. </p>\n "
|
||||
},
|
||||
"S3KeyPrefix": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Value of the Amazon S3 prefix.</p>\n "
|
||||
},
|
||||
"SnsTopicName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. </p>\n "
|
||||
},
|
||||
"IncludeGlobalServiceEvents": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Set to <b>True</b> to include AWS API calls from AWS global services such as IAM. Otherwise, <b>False</b>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Support for passing a Trail object in the CreateTrail or UpdateTrail actions will end as early as February 15, 2014. Instead of the Trail object and its members, use the parameters listed for these actions. </p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Specifies the settings for each trail.</p>\n "
|
||||
|
|
@ -104,38 +74,6 @@
|
|||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Specifies whether the trail is publishing events from global services such as IAM to the log files. </p>\n "
|
||||
},
|
||||
"trail": {
|
||||
"shape_name": "Trail",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Name of the trail set by calling <a>CreateTrail</a>.</p>\n "
|
||||
},
|
||||
"S3BucketName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. </p>\n "
|
||||
},
|
||||
"S3KeyPrefix": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Value of the Amazon S3 prefix.</p>\n "
|
||||
},
|
||||
"SnsTopicName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. </p>\n "
|
||||
},
|
||||
"IncludeGlobalServiceEvents": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Set to <b>True</b> to include AWS API calls from AWS global services such as IAM. Otherwise, <b>False</b>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Support for passing a Trail object in the CreateTrail or UpdateTrail actions will end as early as February 15, 2014. Instead of the Trail object and its members, use the parameters listed for these actions. </p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n Returns the objects or data listed below if successful. Otherwise, returns an error.\n "
|
||||
|
|
@ -194,15 +132,9 @@
|
|||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t"
|
||||
},
|
||||
{
|
||||
"shape_name": "TrailNotProvidedException",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n\t\tThis exception is thrown when no trail is provided.\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>From the command line, use <code>create-subscription</code>. </p>\n <p>Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. </p>\n <note>\n Support for passing <a>Trail</a> as a parameter ends as early as February 25, 2014. The request and response examples in this topic show the use of parameters as well as a Trail object. Until Trail is removed, you can use either Trail or the parameter list. \n \n </note>\n \n \n "
|
||||
"documentation": "\n <p>From the command line, use <code>create-subscription</code>. </p>\n <p>Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. </p>\n \n \n \n "
|
||||
},
|
||||
"DeleteTrail": {
|
||||
"name": "DeleteTrail",
|
||||
|
|
@ -255,10 +187,10 @@
|
|||
"type": "string",
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "\n <p>The list of trails.</p>\n "
|
||||
"documentation": "\n <p>The trail returned.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Returns the list of trails.</p>\n "
|
||||
"documentation": "\n <p>Returns information about the trail.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "DescribeTrailsResponse",
|
||||
|
|
@ -305,7 +237,7 @@
|
|||
"documentation": "\n <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>\n "
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "\n <p>Retrieves the settings for some or all trails associated with an account. </p>\n "
|
||||
"documentation": "\n <p>Retrieves settings for the trail associated with the current region for your account.</p>\n "
|
||||
},
|
||||
"GetTrailStatus": {
|
||||
"name": "GetTrailStatus",
|
||||
|
|
@ -360,36 +292,6 @@
|
|||
"shape_name": "Date",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account. </p>\n "
|
||||
},
|
||||
"LatestDeliveryAttemptTime": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Scheduled for removal as early as February 15, 2014.</p>\n "
|
||||
},
|
||||
"LatestNotificationAttemptTime": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Scheduled for removal as early as February 15, 2014.</p>\n "
|
||||
},
|
||||
"LatestNotificationAttemptSucceeded": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Scheduled for removal as early as February 15, 2014.</p>\n "
|
||||
},
|
||||
"LatestDeliveryAttemptSucceeded": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Scheduled for removal as early as February 15, 2014.</p>\n "
|
||||
},
|
||||
"TimeLoggingStarted": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Scheduled for removal as early as February 15, 2014.</p>\n "
|
||||
},
|
||||
"TimeLoggingStopped": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Scheduled for removal as early as February 15, 2014.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>\n "
|
||||
|
|
@ -408,7 +310,7 @@
|
|||
"documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. </p>\n \n <p>The CloudTrail API is currently undergoing revision. This action currently returns both\n new fields and fields slated for removal from the API. The following lists indicate the\n plans for each field: </p>\n\n<p><b>List of Members Planned for Ongoing Support</b></p>\n<ul>\n <li>IsLogging</li>\n <li>LatestDeliveryTime</li>\n <li>LatestNotificationTime</li>\n <li>StartLoggingTime</li>\n <li>StopLoggingTime</li>\n <li>LatestNotificationError</li>\n <li>LatestDeliveryError</li>\n</ul>\n\n<p><b>List of Members Scheduled for Removal</b></p>\n<ul>\n <li>\n<b>LatestDeliveryAttemptTime</b>: Use <i>LatestDeliveryTime</i> instead.</li>\n <li>\n<b>LatestNotificationAttemptTime</b>: Use <i>LatestNotificationTime</i> instead. </li>\n <li>\n<b>LatestDeliveryAttemptSucceeded</b>: No replacement. See the note following this list.</li>\n <li>\n<b>LatestNotificationAttemptSucceeded</b>: No replacement. See the note following this list. </li>\n <li>\n<b>TimeLoggingStarted</b>: Use <i>StartLoggingTime</i> instead.</li>\n <li>\n<b>TimeLoggingStopped</b>: Use <i>StopLoggingtime</i> instead.</li>\n \n</ul>\n \n<note>\n No replacements have been created for <i>LatestDeliveryAttemptSucceeded</i> and <i>LatestNotificationAttemptSucceeded</i>. Use <i>LatestDeliveryError</i> and <i>LatestNotificationError</i> to evaluate success or failure of log delivery or notification. Empty values returned for these fields indicate success. An error in <i>LatestDeliveryError</i> generally indicates either a missing bucket or insufficient permissions to write to the bucket. Similarly, an error in <i>LatestNotificationError</i> indicates either a missing topic or insufficient permissions. \n \n</note> \n\n\n "
|
||||
"documentation": "\n <p>Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. </p>\n \n \n\n\n "
|
||||
},
|
||||
"StartLogging": {
|
||||
"name": "StartLogging",
|
||||
|
|
@ -493,7 +395,8 @@
|
|||
"Name": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Specifies the name of the trail.</p>\n "
|
||||
"documentation": "\n <p>Specifies the name of the trail.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"S3BucketName": {
|
||||
"shape_name": "String",
|
||||
|
|
@ -514,38 +417,6 @@
|
|||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Specifies whether the trail is publishing events from global services such as IAM to the log files. </p>\n "
|
||||
},
|
||||
"trail": {
|
||||
"shape_name": "Trail",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Name of the trail set by calling <a>CreateTrail</a>.</p>\n "
|
||||
},
|
||||
"S3BucketName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. </p>\n "
|
||||
},
|
||||
"S3KeyPrefix": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Value of the Amazon S3 prefix.</p>\n "
|
||||
},
|
||||
"SnsTopicName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. </p>\n "
|
||||
},
|
||||
"IncludeGlobalServiceEvents": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Set to <b>True</b> to include AWS API calls from AWS global services such as IAM. Otherwise, <b>False</b>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Support for passing a Trail object in the CreateTrail or UpdateTrail actions will end as early as February 15, 2014. Instead of the Trail object and its members, use the parameters listed for these actions. </p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Specifies settings to update for the trail.</p>\n "
|
||||
|
|
@ -578,38 +449,6 @@
|
|||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Specifies whether the trail is publishing events from global services such as IAM to the log files. </p>\n "
|
||||
},
|
||||
"trail": {
|
||||
"shape_name": "Trail",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Name of the trail set by calling <a>CreateTrail</a>.</p>\n "
|
||||
},
|
||||
"S3BucketName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. </p>\n "
|
||||
},
|
||||
"S3KeyPrefix": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Value of the Amazon S3 prefix.</p>\n "
|
||||
},
|
||||
"SnsTopicName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. </p>\n "
|
||||
},
|
||||
"IncludeGlobalServiceEvents": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Set to <b>True</b> to include AWS API calls from AWS global services such as IAM. Otherwise, <b>False</b>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the CloudTrail settings that were updated by calling <a>UpdateTrail</a>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n Returns the objects or data listed below if successful. Otherwise, returns an error.\n "
|
||||
|
|
@ -662,15 +501,9 @@
|
|||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t"
|
||||
},
|
||||
{
|
||||
"shape_name": "TrailNotProvidedException",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n\t\tThis exception is thrown when no trail is provided.\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>From the command line, use <code>update-subscription</code>.</p> \n <p>Updates the settings that specify delivery of log files. Changes to a trail do not require\n stopping the CloudTrail service. Use this action to designate an existing bucket for log\n delivery. If the existing bucket has previously been a target for CloudTrail log files,\n an IAM policy exists for the bucket. </p>\n \n <note>\n Support for passing <a>Trail</a> as a parameter ends as early as February 25, 2014. The request and response examples in this topic show the use of parameters as well as a Trail object. Until Trail is removed, you can use either Trail or the parameter list. \n \n </note>\n \n "
|
||||
"documentation": "\n <p>From the command line, use <code>update-subscription</code>.</p> \n <p>Updates the settings that specify delivery of log files. Changes to a trail do not require\n stopping the CloudTrail service. Use this action to designate an existing bucket for log\n delivery. If the existing bucket has previously been a target for CloudTrail log files,\n an IAM policy exists for the bucket. </p>\n \n \n "
|
||||
}
|
||||
},
|
||||
"retry": {
|
||||
|
|
|
|||
1316
botocore/data/aws/cognito-identity/2014-06-30.json
Normal file
1316
botocore/data/aws/cognito-identity/2014-06-30.json
Normal file
|
|
@ -0,0 +1,1316 @@
|
|||
{
|
||||
"api_version": "2014-06-30",
|
||||
"type": "json",
|
||||
"json_version": "1.1",
|
||||
"signature_version": "v4",
|
||||
"service_full_name": "Amazon Cognito Identity",
|
||||
"endpoint_prefix": "cognito-identity",
|
||||
"target_prefix": "AWSCognitoIdentityService",
|
||||
"xmlnamespace": "http://cognito-identity.amazonaws.com/doc/2014-06-30/",
|
||||
"documentation": "\n <fullname>Amazon Cognito</fullname>\n <p>Amazon Cognito is a web service that facilitates the delivery of scoped, temporary credentials\n to mobile devices or other untrusted environments. Amazon Cognito uniquely identifies a device\n or user and supplies the user with a consistent identity throughout the lifetime of an\n application.</p>\n <p>Amazon Cognito lets users authenticate with third-party identity providers (Facebook, Google, or\n Login with Amazon). As a developer, you decide which identity providers to trust. You can\n also choose to support unauthenticated access from your application. Your users are\n provided with Cognito tokens that uniquely identify their device and any information\n provided about third-party logins.</p>\n ",
|
||||
"operations": {
|
||||
"CreateIdentityPool": {
|
||||
"name": "CreateIdentityPool",
|
||||
"input": {
|
||||
"shape_name": "CreateIdentityPoolInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolName": {
|
||||
"shape_name": "IdentityPoolName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w ]+",
|
||||
"documentation": "\n <p>A string that you provide.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"AllowUnauthenticatedIdentities": {
|
||||
"shape_name": "IdentityPoolUnauthenticated",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>TRUE if the identity pool supports unauthenticated logins.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"SupportedLoginProviders": {
|
||||
"shape_name": "IdentityProviders",
|
||||
"type": "map",
|
||||
"keys": {
|
||||
"shape_name": "IdentityProviderName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w._-]+",
|
||||
"documentation": null
|
||||
},
|
||||
"members": {
|
||||
"shape_name": "IdentityProviderId",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w._-]+",
|
||||
"documentation": null
|
||||
},
|
||||
"max_length": 3,
|
||||
"documentation": "\n <p>Optional key:value pairs mapping provider names to provider app IDs.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Input to the CreateIdentityPool action.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "IdentityPool",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "An identity pool ID in the format\n REGION:GUID.",
|
||||
"required": true
|
||||
},
|
||||
"IdentityPoolName": {
|
||||
"shape_name": "IdentityPoolName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w ]+",
|
||||
"documentation": "\n <p>A string that you provide.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"AllowUnauthenticatedIdentities": {
|
||||
"shape_name": "IdentityPoolUnauthenticated",
|
||||
"type": "boolean",
|
||||
"documentation": "TRUE if the identity pool\n supports unauthenticated logins.",
|
||||
"required": true
|
||||
},
|
||||
"SupportedLoginProviders": {
|
||||
"shape_name": "IdentityProviders",
|
||||
"type": "map",
|
||||
"keys": {
|
||||
"shape_name": "IdentityProviderName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w._-]+",
|
||||
"documentation": null
|
||||
},
|
||||
"members": {
|
||||
"shape_name": "IdentityProviderId",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w._-]+",
|
||||
"documentation": null
|
||||
},
|
||||
"max_length": 3,
|
||||
"documentation": "\n <p>Optional key:value pairs mapping provider names to provider app IDs.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "An object representing a Cognito identity\n pool."
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidParameterException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by an\n InvalidParameterException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown for missing or bad input\n parameter(s)."
|
||||
},
|
||||
{
|
||||
"shape_name": "NotAuthorizedException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n NotAuthorizedException"
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user is not authorized to access the\n requested resource."
|
||||
},
|
||||
{
|
||||
"shape_name": "ResourceConflictException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n ResourceConflictException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user tries to use a login which\n is already linked to another account."
|
||||
},
|
||||
{
|
||||
"shape_name": "TooManyRequestsException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by a\n TooManyRequestsException"
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a request is\n throttled."
|
||||
},
|
||||
{
|
||||
"shape_name": "InternalErrorException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by an\n InternalErrorException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when the service encounters an error during\n processing the request."
|
||||
},
|
||||
{
|
||||
"shape_name": "LimitExceededException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n LimitExceededException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when the total number of user pools has\n exceeded a preset limit."
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Creates a new identity pool. The identity pool is a store of user identity information that\n is specific to your AWS account.</p>\n <examples>\n <example>\n <name>CreateIdentityPool</name>\n <description>The following example shows a request and response for a CreateIdentityPool\n operation.</description>\n <request>\n{\n \"IdentityPoolName\": \"MyIdentityPool\", \n \"IdentityPoolDescription\": \"My identity pool\", \n \"Unauthenticated\": true, \n \"SupportedLoginProviders\": {\n \"graph.facebook.com\": \"Facebook_App_ID\", \n \"accounts.google.com\": \"Google_App_ID\", \n \"www.amazon.com\": \"Amazon_App_ID\" \n } \n} \n </request>\n <response>\n{\n \"IdentityPoolDescription\": \"My identity pool\", \n \"IdentityPoolId\": \"us-east-1:1a234b56-7890-1cd2-3e45-f6g7hEXAMPLE\", \n \"IdentityPoolName\": \"MyIdentityPool\",\n \"SupportedLoginProviders\": { \n \"www.amazon.com\": \"Amazon_App_ID\", \n \"graph.facebook.com\": \"Facebook_App_ID\", \n \"accounts.google.com\": \"Google_App_ID\" \n }, \n \"Unauthenticated\": true\n}\n </response>\n </example>\n </examples>\n "
|
||||
},
|
||||
"DeleteIdentityPool": {
|
||||
"name": "DeleteIdentityPool",
|
||||
"input": {
|
||||
"shape_name": "DeleteIdentityPoolInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "An identity pool ID in the format\n REGION:GUID.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Input to the DeleteIdentityPool action.</p>\n "
|
||||
},
|
||||
"output": null,
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidParameterException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by an\n InvalidParameterException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown for missing or bad input\n parameter(s)."
|
||||
},
|
||||
{
|
||||
"shape_name": "ResourceNotFoundException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n ResourceNotFoundException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when the requested resource (for\n example, a dataset or record) does not exist."
|
||||
},
|
||||
{
|
||||
"shape_name": "NotAuthorizedException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n NotAuthorizedException"
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user is not authorized to access the\n requested resource."
|
||||
},
|
||||
{
|
||||
"shape_name": "TooManyRequestsException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by a\n TooManyRequestsException"
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a request is\n throttled."
|
||||
},
|
||||
{
|
||||
"shape_name": "InternalErrorException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by an\n InternalErrorException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when the service encounters an error during\n processing the request."
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with\n the pool.</p>\n <examples>\n <example>\n <name>DeleteIdentityPool</name>\n <description>The following is an example of a DeleteIdentityPool request.</description>\n <request>\n{\n \"IdentityPoolId\": \"us-east-1:1a234b56-7890-1cd2-3e45-f6g7hEXAMPLE\"\n}\n </request>\n </example>\n </examples>\n "
|
||||
},
|
||||
"DescribeIdentityPool": {
|
||||
"name": "DescribeIdentityPool",
|
||||
"input": {
|
||||
"shape_name": "DescribeIdentityPoolInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "An identity pool ID in the\n format REGION:GUID.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Input to the DescribeIdentityPool\n action."
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "IdentityPool",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "An identity pool ID in the format\n REGION:GUID.",
|
||||
"required": true
|
||||
},
|
||||
"IdentityPoolName": {
|
||||
"shape_name": "IdentityPoolName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w ]+",
|
||||
"documentation": "\n <p>A string that you provide.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"AllowUnauthenticatedIdentities": {
|
||||
"shape_name": "IdentityPoolUnauthenticated",
|
||||
"type": "boolean",
|
||||
"documentation": "TRUE if the identity pool\n supports unauthenticated logins.",
|
||||
"required": true
|
||||
},
|
||||
"SupportedLoginProviders": {
|
||||
"shape_name": "IdentityProviders",
|
||||
"type": "map",
|
||||
"keys": {
|
||||
"shape_name": "IdentityProviderName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w._-]+",
|
||||
"documentation": null
|
||||
},
|
||||
"members": {
|
||||
"shape_name": "IdentityProviderId",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w._-]+",
|
||||
"documentation": null
|
||||
},
|
||||
"max_length": 3,
|
||||
"documentation": "\n <p>Optional key:value pairs mapping provider names to provider app IDs.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "An object representing a Cognito identity\n pool."
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidParameterException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by an\n InvalidParameterException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown for missing or bad input\n parameter(s)."
|
||||
},
|
||||
{
|
||||
"shape_name": "ResourceNotFoundException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n ResourceNotFoundException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when the requested resource (for\n example, a dataset or record) does not exist."
|
||||
},
|
||||
{
|
||||
"shape_name": "NotAuthorizedException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n NotAuthorizedException"
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user is not authorized to access the\n requested resource."
|
||||
},
|
||||
{
|
||||
"shape_name": "TooManyRequestsException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by a\n TooManyRequestsException"
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a request is\n throttled."
|
||||
},
|
||||
{
|
||||
"shape_name": "InternalErrorException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by an\n InternalErrorException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when the service encounters an error during\n processing the request."
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Gets details about a particular identity pool, including the pool name, ID description,\n creation date, and current number of users.</p>\n <examples>\n <example>\n <name>DescribeIdentityPool</name>\n <description>The following are an example request and response for the\n DescribeIdentityPool operation.</description>\n <request>\n{\n \"IdentityPoolId\": \"us-east-1:af4311ca-835e-4b49-814c-2290EXAMPLE1\" \n} \n </request>\n <response>\n{ \n \"IdentityPoolDescription\": \"My identity pool\", \n \"IdentityPoolId\": \"us-east-1:af4311ca-835e-4b49-814c-2290EXAMPLE1\", \n \"IdentityPoolName\": \"MyIdentityPool\",\n \"SupportedLoginProviders\": { \n \"www.amazon.com\": \"Amazon_App_ID\", \n \"graph.facebook.com\": \"Facebook_App_ID\", \n \"accounts.google.com\": \"Google_App_ID\" \n },\n \"Unauthenticated\": true \n}\n </response>\n </example>\n </examples>\n "
|
||||
},
|
||||
"GetId": {
|
||||
"name": "GetId",
|
||||
"input": {
|
||||
"shape_name": "GetIdInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"AccountId": {
|
||||
"shape_name": "AccountId",
|
||||
"type": "string",
|
||||
"pattern": "\\d+",
|
||||
"min_length": 1,
|
||||
"max_length": 15,
|
||||
"documentation": "A standard AWS account ID (9+\n digits).",
|
||||
"required": true
|
||||
},
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "An identity pool ID in the format\n REGION:GUID.",
|
||||
"required": true
|
||||
},
|
||||
"Logins": {
|
||||
"shape_name": "LoginsMap",
|
||||
"type": "map",
|
||||
"keys": {
|
||||
"shape_name": "IdentityProviderName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w._-]+",
|
||||
"documentation": null
|
||||
},
|
||||
"members": {
|
||||
"shape_name": "IdentityProviderToken",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 1024,
|
||||
"pattern": "[\\S]+",
|
||||
"documentation": null
|
||||
},
|
||||
"max_length": 3,
|
||||
"documentation": "A set of optional name/value pairs that map provider\n names to provider tokens."
|
||||
}
|
||||
},
|
||||
"documentation": "Input to the GetId action."
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "GetIdResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityId": {
|
||||
"shape_name": "IdentityId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A unique identifier in the format\n REGION:GUID."
|
||||
}
|
||||
},
|
||||
"documentation": "Returned in the response to a GetId\n request."
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidParameterException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by an\n InvalidParameterException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown for missing or bad input\n parameter(s)."
|
||||
},
|
||||
{
|
||||
"shape_name": "ResourceNotFoundException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n ResourceNotFoundException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when the requested resource (for\n example, a dataset or record) does not exist."
|
||||
},
|
||||
{
|
||||
"shape_name": "NotAuthorizedException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n NotAuthorizedException"
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user is not authorized to access the\n requested resource."
|
||||
},
|
||||
{
|
||||
"shape_name": "ResourceConflictException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n ResourceConflictException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user tries to use a login which\n is already linked to another account."
|
||||
},
|
||||
{
|
||||
"shape_name": "TooManyRequestsException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by a\n TooManyRequestsException"
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a request is\n throttled."
|
||||
},
|
||||
{
|
||||
"shape_name": "InternalErrorException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by an\n InternalErrorException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when the service encounters an error during\n processing the request."
|
||||
},
|
||||
{
|
||||
"shape_name": "LimitExceededException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n LimitExceededException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when the total number of user pools has\n exceeded a preset limit."
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit\n linked account.</p>\n <examples>\n <example>\n <name>GetId</name>\n <description> The following example shows a GetId request for an unauthenticated\n identity.</description>\n <request> \n{\n \"AccountId\": \"123456789012;\", \n \"IdentityPoolId\": \"us-east-1:af4311ca-835e-4b49-814c-2290EXAMPLE1\" \n} \n </request>\n <response>\n{\n \"IdentityId\": \"us-east-1:852d4250-9eec-4006-8f84-4e82EXAMPLE3\"\n}\n </response>\n </example>\n </examples>\n "
|
||||
},
|
||||
"GetOpenIdToken": {
|
||||
"name": "GetOpenIdToken",
|
||||
"input": {
|
||||
"shape_name": "GetOpenIdTokenInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityId": {
|
||||
"shape_name": "IdentityId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A unique identifier in the format\n REGION:GUID.",
|
||||
"required": true
|
||||
},
|
||||
"Logins": {
|
||||
"shape_name": "LoginsMap",
|
||||
"type": "map",
|
||||
"keys": {
|
||||
"shape_name": "IdentityProviderName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w._-]+",
|
||||
"documentation": null
|
||||
},
|
||||
"members": {
|
||||
"shape_name": "IdentityProviderToken",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 1024,
|
||||
"pattern": "[\\S]+",
|
||||
"documentation": null
|
||||
},
|
||||
"max_length": 3,
|
||||
"documentation": "A set of optional name/value pairs that map\n provider names to provider tokens."
|
||||
}
|
||||
},
|
||||
"documentation": "Input to the GetOpenIdToken action."
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "GetOpenIdTokenResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityId": {
|
||||
"shape_name": "IdentityId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A unique identifier in the format\n REGION:GUID. Note that the IdentityId returned may not match the one passed on\n input."
|
||||
},
|
||||
"Token": {
|
||||
"shape_name": "OIDCToken",
|
||||
"type": "string",
|
||||
"documentation": "An OpenID token."
|
||||
}
|
||||
},
|
||||
"documentation": "Returned in response to a successful\n GetOpenIdToken request."
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidParameterException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by an\n InvalidParameterException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown for missing or bad input\n parameter(s)."
|
||||
},
|
||||
{
|
||||
"shape_name": "ResourceNotFoundException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n ResourceNotFoundException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when the requested resource (for\n example, a dataset or record) does not exist."
|
||||
},
|
||||
{
|
||||
"shape_name": "NotAuthorizedException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n NotAuthorizedException"
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user is not authorized to access the\n requested resource."
|
||||
},
|
||||
{
|
||||
"shape_name": "ResourceConflictException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n ResourceConflictException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user tries to use a login which\n is already linked to another account."
|
||||
},
|
||||
{
|
||||
"shape_name": "TooManyRequestsException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by a\n TooManyRequestsException"
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a request is\n throttled."
|
||||
},
|
||||
{
|
||||
"shape_name": "InternalErrorException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by an\n InternalErrorException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when the service encounters an error during\n processing the request."
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned from\n GetId. You can optionally add additional logins for the identity. Supplying multiple logins\n creates an implicit link.</p>\n <examples>\n <example>\n <name>GetOpenIdToken</name>\n <description>The following examples show a GetOpenIdToken request and response, without\n the optional login values.</description>\n <request>\n{\n \"IdentityId\": \"us-east-1:852d4250-9eec-4006-8f84-4e82EXAMPLE3\"\n}\n </request>\n <response>\n{\n \"IdentityId\": \"us-east-1:852d4250-9eec-4006-8f84-4e82EXAMPLE3\", \n \"Token\": \"EXAmpLeTOkENUzUxMiIsInR5cCI6IkpXUyIsImtpZCI6InVzLWVhc3QtMTEifQ.eyJleHAiOjE0MDI2Njg0NTAsInN1YiI6InVzLWVhc3QtMTo5MjFhMzg0My0yZGQ2LTQ2YjgtYWIyZi1jNjc5NTUyZTM3MWUiLCJhdWQiOiJ1cy1lYXN0LTE6YWY0MzExY2EtODM1ZS00YjQ5LTgxNGMtMjI5MGQ4ZDU1YTZmIiwiaXNzIjoiaHR0cHM6Ly9jb2duaXRvLWlkZW50aXR5LXB1YmxpYy1pYWQtYmV0YS5hbWF6b24uY29tIiwiaWF0IjoxNDAyNjY3ODUwLCJhbXIiOlsidW5hdXRoZW50aWNhdGVkIl19.faWdRGsKxT8YqTBnAow1fNyXE57kjScKQ0lyFpFAUIl6VNVV-nQ_QD8XKHB_pAY2UNtxYFDoGhHrL3cqH_FLSfRLG-X3EaIrCsr0A6KIW7X69wsAxJQB-EvYru0UhDpcPaDyQUXTHFmRP9bzJMsSLi7nXm-OD4DCujX3vKwOhlSymbH9KbAG105t3_G_a8tsUbCV488nvlrA-7Omp0D18T1__XeZttldW1GODOK2OY2bK5-3eyodcqbVXaPTotxO5PTlYpzuMS1XfTejC8LJ2DocP_eBT7xhSr2qkro9Y6uCDph_-6ttYrXRaaLKZv3v1Lz6PGHrsPhJdK_bYRHhdg\"\n}\n </response>\n </example>\n </examples>\n "
|
||||
},
|
||||
"ListIdentities": {
|
||||
"name": "ListIdentities",
|
||||
"input": {
|
||||
"shape_name": "ListIdentitiesInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "An identity pool ID in the format\n REGION:GUID.",
|
||||
"required": true
|
||||
},
|
||||
"MaxResults": {
|
||||
"shape_name": "QueryLimit",
|
||||
"type": "integer",
|
||||
"min_length": 1,
|
||||
"max_length": 60,
|
||||
"documentation": "The maximum number of identities to return.",
|
||||
"required": true
|
||||
},
|
||||
"NextToken": {
|
||||
"shape_name": "PaginationKey",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"documentation": " A pagination token. "
|
||||
}
|
||||
},
|
||||
"documentation": "Input to the ListIdentities action."
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ListIdentitiesResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "An identity pool ID in the format\n REGION:GUID."
|
||||
},
|
||||
"Identities": {
|
||||
"shape_name": "IdentitiesList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "IdentityDescription",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityId": {
|
||||
"shape_name": "IdentityId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A unique identifier in the format\n REGION:GUID."
|
||||
},
|
||||
"Logins": {
|
||||
"shape_name": "LoginsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "IdentityProviderName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w._-]+",
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "A set of optional name/value pairs that map\n provider names to provider tokens."
|
||||
}
|
||||
},
|
||||
"documentation": "A description of the identity."
|
||||
},
|
||||
"documentation": "An object containing a set of\n identities and associated mappings."
|
||||
},
|
||||
"NextToken": {
|
||||
"shape_name": "PaginationKey",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"documentation": "A pagination token."
|
||||
}
|
||||
},
|
||||
"documentation": "The response to a ListIdentities\n request."
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidParameterException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by an\n InvalidParameterException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown for missing or bad input\n parameter(s)."
|
||||
},
|
||||
{
|
||||
"shape_name": "ResourceNotFoundException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n ResourceNotFoundException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when the requested resource (for\n example, a dataset or record) does not exist."
|
||||
},
|
||||
{
|
||||
"shape_name": "NotAuthorizedException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n NotAuthorizedException"
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user is not authorized to access the\n requested resource."
|
||||
},
|
||||
{
|
||||
"shape_name": "TooManyRequestsException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by a\n TooManyRequestsException"
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a request is\n throttled."
|
||||
},
|
||||
{
|
||||
"shape_name": "InternalErrorException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by an\n InternalErrorException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when the service encounters an error during\n processing the request."
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Lists the identities in a pool.</p>\n <examples>\n <example>\n <name>ListIdentities</name>\n <description>The following are examples of a request and a response for the\n ListIdentities action.</description>\n <request>\n{\n \"IdentityPoolId\": \"us-east-1:1a234b56-7890-1cd2-3e45-f6g7hEXAMPLE\", \n \"MaxResults\": 10\n}\n </request>\n <response>\n{\n \"Identities\": \n [\n {\n \"IdentityId\": \"us-east-1:2345a6b7-8cc3-4a60-8aeb-e11bEXAMPLE4\"\n }, \n {\n \"IdentityId\": \"us-east-1:852d4250-9eec-4006-8f84-4e82EXAMPLE3\"\n }, \n {\n \"IdentityId\": \"us-east-1:921a3843-2dd6-46b8-ab2f-c679EXAMPLE5\"\n }\n ], \n \"IdentityPoolId\": \"us-east-1:1a234b56-7890-1cd2-3e45-f6g7hEXAMPLE\"\n}\n </response>\n </example>\n </examples>\n "
|
||||
},
|
||||
"ListIdentityPools": {
|
||||
"name": "ListIdentityPools",
|
||||
"input": {
|
||||
"shape_name": "ListIdentityPoolsInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"MaxResults": {
|
||||
"shape_name": "QueryLimit",
|
||||
"type": "integer",
|
||||
"min_length": 1,
|
||||
"max_length": 60,
|
||||
"documentation": " The maximum number of identities\n to return. ",
|
||||
"required": true
|
||||
},
|
||||
"NextToken": {
|
||||
"shape_name": "PaginationKey",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"documentation": " A pagination token. "
|
||||
}
|
||||
},
|
||||
"documentation": "Input to the ListIdentityPools\n action."
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ListIdentityPoolsResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPools": {
|
||||
"shape_name": "IdentityPoolsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "IdentityPoolShortDescription",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "An identity pool ID in the\n format REGION:GUID."
|
||||
},
|
||||
"IdentityPoolName": {
|
||||
"shape_name": "IdentityPoolName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w ]+",
|
||||
"documentation": "A string that you\n provide."
|
||||
}
|
||||
},
|
||||
"documentation": "A description of the identity\n pool."
|
||||
},
|
||||
"documentation": "The identity pools returned by\n the ListIdentityPools action."
|
||||
},
|
||||
"NextToken": {
|
||||
"shape_name": "PaginationKey",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"documentation": "A pagination token."
|
||||
}
|
||||
},
|
||||
"documentation": "The result of a successful ListIdentityPools\n action."
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidParameterException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by an\n InvalidParameterException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown for missing or bad input\n parameter(s)."
|
||||
},
|
||||
{
|
||||
"shape_name": "NotAuthorizedException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n NotAuthorizedException"
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user is not authorized to access the\n requested resource."
|
||||
},
|
||||
{
|
||||
"shape_name": "TooManyRequestsException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by a\n TooManyRequestsException"
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a request is\n throttled."
|
||||
},
|
||||
{
|
||||
"shape_name": "InternalErrorException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by an\n InternalErrorException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when the service encounters an error during\n processing the request."
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Lists all of the Cognito identity pools registered for your account.</p>\n <examples>\n <example>\n <name>ListIdentityPools</name>\n <description>The following example shows a request and a response for a\n ListIdentityPools operation.</description>\n <request>\n{\n \"MaxResults\": 10\n}\n </request>\n <response>\n{\n \"IdentityPools\": \n [\n {\n \"IdentityPoolId\": \"us-east-1:af4311ca-835e-4b49-814c-2290EXAMPLE1\", \n \"IdentityPoolName\": \"MyPool\"\n }, \n {\n \"IdentityPoolId\": \"us-east-1:f212b602-a526-4557-af13-8eedEXAMPLE2\", \n \"IdentityPoolName\": \"MyPool2\"\n }\n ]\n}\n </response>\n </example>\n </examples>\n "
|
||||
},
|
||||
"UnlinkIdentity": {
|
||||
"name": "UnlinkIdentity",
|
||||
"input": {
|
||||
"shape_name": "UnlinkIdentityInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityId": {
|
||||
"shape_name": "IdentityId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A unique identifier in the format\n REGION:GUID.",
|
||||
"required": true
|
||||
},
|
||||
"Logins": {
|
||||
"shape_name": "LoginsMap",
|
||||
"type": "map",
|
||||
"keys": {
|
||||
"shape_name": "IdentityProviderName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w._-]+",
|
||||
"documentation": null
|
||||
},
|
||||
"members": {
|
||||
"shape_name": "IdentityProviderToken",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 1024,
|
||||
"pattern": "[\\S]+",
|
||||
"documentation": null
|
||||
},
|
||||
"max_length": 3,
|
||||
"documentation": "A set of optional name/value pairs that map\n provider names to provider tokens.",
|
||||
"required": true
|
||||
},
|
||||
"LoginsToRemove": {
|
||||
"shape_name": "LoginsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "IdentityProviderName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w._-]+",
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "Provider names to unlink from this identity.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Input to the UnlinkIdentity action."
|
||||
},
|
||||
"output": null,
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidParameterException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by an\n InvalidParameterException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown for missing or bad input\n parameter(s)."
|
||||
},
|
||||
{
|
||||
"shape_name": "ResourceNotFoundException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n ResourceNotFoundException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when the requested resource (for\n example, a dataset or record) does not exist."
|
||||
},
|
||||
{
|
||||
"shape_name": "NotAuthorizedException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n NotAuthorizedException"
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user is not authorized to access the\n requested resource."
|
||||
},
|
||||
{
|
||||
"shape_name": "ResourceConflictException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n ResourceConflictException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user tries to use a login which\n is already linked to another account."
|
||||
},
|
||||
{
|
||||
"shape_name": "TooManyRequestsException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by a\n TooManyRequestsException"
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a request is\n throttled."
|
||||
},
|
||||
{
|
||||
"shape_name": "InternalErrorException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by an\n InternalErrorException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when the service encounters an error during\n processing the request."
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Unlinks a federated identity from an existing account. Unlinked logins will be considered\n new identities next time they are seen. Removing the last linked login will make this\n identity inaccessible.</p>\n "
|
||||
},
|
||||
"UpdateIdentityPool": {
|
||||
"name": "UpdateIdentityPool",
|
||||
"input": {
|
||||
"shape_name": "IdentityPool",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "An identity pool ID in the format\n REGION:GUID.",
|
||||
"required": true
|
||||
},
|
||||
"IdentityPoolName": {
|
||||
"shape_name": "IdentityPoolName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w ]+",
|
||||
"documentation": "\n <p>A string that you provide.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"AllowUnauthenticatedIdentities": {
|
||||
"shape_name": "IdentityPoolUnauthenticated",
|
||||
"type": "boolean",
|
||||
"documentation": "TRUE if the identity pool\n supports unauthenticated logins.",
|
||||
"required": true
|
||||
},
|
||||
"SupportedLoginProviders": {
|
||||
"shape_name": "IdentityProviders",
|
||||
"type": "map",
|
||||
"keys": {
|
||||
"shape_name": "IdentityProviderName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w._-]+",
|
||||
"documentation": null
|
||||
},
|
||||
"members": {
|
||||
"shape_name": "IdentityProviderId",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w._-]+",
|
||||
"documentation": null
|
||||
},
|
||||
"max_length": 3,
|
||||
"documentation": "\n <p>Optional key:value pairs mapping provider names to provider app IDs.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "An object representing a Cognito identity\n pool."
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "IdentityPool",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "An identity pool ID in the format\n REGION:GUID.",
|
||||
"required": true
|
||||
},
|
||||
"IdentityPoolName": {
|
||||
"shape_name": "IdentityPoolName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w ]+",
|
||||
"documentation": "\n <p>A string that you provide.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"AllowUnauthenticatedIdentities": {
|
||||
"shape_name": "IdentityPoolUnauthenticated",
|
||||
"type": "boolean",
|
||||
"documentation": "TRUE if the identity pool\n supports unauthenticated logins.",
|
||||
"required": true
|
||||
},
|
||||
"SupportedLoginProviders": {
|
||||
"shape_name": "IdentityProviders",
|
||||
"type": "map",
|
||||
"keys": {
|
||||
"shape_name": "IdentityProviderName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w._-]+",
|
||||
"documentation": null
|
||||
},
|
||||
"members": {
|
||||
"shape_name": "IdentityProviderId",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[\\w._-]+",
|
||||
"documentation": null
|
||||
},
|
||||
"max_length": 3,
|
||||
"documentation": "\n <p>Optional key:value pairs mapping provider names to provider app IDs.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "An object representing a Cognito identity\n pool."
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidParameterException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by an\n InvalidParameterException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown for missing or bad input\n parameter(s)."
|
||||
},
|
||||
{
|
||||
"shape_name": "ResourceNotFoundException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n ResourceNotFoundException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when the requested resource (for\n example, a dataset or record) does not exist."
|
||||
},
|
||||
{
|
||||
"shape_name": "NotAuthorizedException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n NotAuthorizedException"
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user is not authorized to access the\n requested resource."
|
||||
},
|
||||
{
|
||||
"shape_name": "ResourceConflictException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n ResourceConflictException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user tries to use a login which\n is already linked to another account."
|
||||
},
|
||||
{
|
||||
"shape_name": "TooManyRequestsException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by a\n TooManyRequestsException"
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a request is\n throttled."
|
||||
},
|
||||
{
|
||||
"shape_name": "InternalErrorException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by an\n InternalErrorException."
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when the service encounters an error during\n processing the request."
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Updates a user pool.</p>\n <examples>\n <example>\n <name>UpdateIdentityPool</name>\n <description>The following are a request and response for the UpdateIdentityPool\n action.</description>\n <request>\n{\n \"IdentityPoolId\": \"us-east-1:1a234b56-7890-1cd2-3e45-f6g7hEXAMPLE\", \n \"IdentityPoolName\": \"MyUpdatedPool\", \n \"IdentityPoolDescription\": \"An identity pool that needs updating\", \n \"Unauthenticated\": true, \n \"SupportedLoginProviders\": \n {\n \"www.amazon.com\": \"Amazon_App_ID\", \n \"graph.facebook.com\": \"Facebook_App_ID\", \n \"accounts.google.com\": \"Google_App_ID\"\n }\n}\n </request>\n <response>\n{\n \"IdentityPoolDescription\": \"An identity pool that needs updating\", \n \"IdentityPoolId\": \"us-east-1:1a234b56-7890-1cd2-3e45-f6g7hEXAMPLE\", \n \"IdentityPoolName\": \"MyUpdatedPool\", \n \"SupportedLoginProviders\": \n {\n \"www.amazon.com\": \"Amazon_App_ID\", \n \"graph.facebook.com\": \"Facebook_App_ID\", \n \"accounts.google.com\": \"Google_App_ID\"\n }, \n \"AllowUnauthenticatedIdentities\": true\n}\n </response>\n </example>\n </examples>\n "
|
||||
}
|
||||
},
|
||||
"retry": {
|
||||
"__default__": {
|
||||
"max_attempts": 5,
|
||||
"delay": {
|
||||
"type": "exponential",
|
||||
"base": "rand",
|
||||
"growth_factor": 2
|
||||
},
|
||||
"policies": {
|
||||
"general_socket_errors": {
|
||||
"applies_when": {
|
||||
"socket_errors": [
|
||||
"GENERAL_CONNECTION_ERROR"
|
||||
]
|
||||
}
|
||||
},
|
||||
"general_server_error": {
|
||||
"applies_when": {
|
||||
"response": {
|
||||
"http_status_code": 500
|
||||
}
|
||||
}
|
||||
},
|
||||
"service_unavailable": {
|
||||
"applies_when": {
|
||||
"response": {
|
||||
"http_status_code": 503
|
||||
}
|
||||
}
|
||||
},
|
||||
"limit_exceeded": {
|
||||
"applies_when": {
|
||||
"response": {
|
||||
"http_status_code": 509
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
1369
botocore/data/aws/cognito-sync/2014-06-30.json
Normal file
1369
botocore/data/aws/cognito-sync/2014-06-30.json
Normal file
|
|
@ -0,0 +1,1369 @@
|
|||
{
|
||||
"api_version": "2014-06-30",
|
||||
"type": "rest-json",
|
||||
"signature_version": "v4",
|
||||
"service_full_name": "Amazon Cognito Service",
|
||||
"endpoint_prefix": "cognito-sync",
|
||||
"target_prefix": "AWSCognitoSyncService",
|
||||
"documentation": "\n <fullname>Amazon Cognito Sync</fullname>\n <p>Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of\n application-related user data. High-level client libraries are available for both iOS and\n Android. You can use these libraries to persist data locally so that it's available even if\n the device is offline. Developer credentials don't need to be stored on the mobile device\n to access the service. You can use Amazon Cognito to obtain a normalized user ID and\n credentials. User data is persisted in a dataset that can store up to 1 MB of key-value\n pairs, and you can have up to 20 datasets per user identity.</p>\n ",
|
||||
"operations": {
|
||||
"DeleteDataset": {
|
||||
"name": "DeleteDataset",
|
||||
"http": {
|
||||
"method": "DELETE",
|
||||
"uri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}",
|
||||
"response_code": 200
|
||||
},
|
||||
"input": {
|
||||
"shape_name": "DeleteDatasetRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
},
|
||||
"IdentityId": {
|
||||
"shape_name": "IdentityId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
},
|
||||
"DatasetName": {
|
||||
"shape_name": "DatasetName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[a-zA-Z0-9_.:-]+",
|
||||
"documentation": "A string of up to 128 characters.\n Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.'\n (dot).",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
}
|
||||
},
|
||||
"documentation": "A request to delete the specific\n dataset."
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "DeleteDatasetResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Dataset": {
|
||||
"shape_name": "Dataset",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityId": {
|
||||
"shape_name": "IdentityId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region."
|
||||
},
|
||||
"DatasetName": {
|
||||
"shape_name": "DatasetName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[a-zA-Z0-9_.:-]+",
|
||||
"documentation": "A string of up to 128 characters. Allowed characters\n are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)."
|
||||
},
|
||||
"CreationDate": {
|
||||
"shape_name": "Date",
|
||||
"type": "timestamp",
|
||||
"documentation": "Date."
|
||||
},
|
||||
"LastModifiedDate": {
|
||||
"shape_name": "Date",
|
||||
"type": "timestamp",
|
||||
"documentation": "Date when the dataset was last\n modified."
|
||||
},
|
||||
"LastModifiedBy": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The device that made the last change to this\n dataset."
|
||||
},
|
||||
"DataStorage": {
|
||||
"shape_name": "Long",
|
||||
"type": "long",
|
||||
"documentation": "Total size in bytes of the records in this\n dataset."
|
||||
},
|
||||
"NumRecords": {
|
||||
"shape_name": "Long",
|
||||
"type": "long",
|
||||
"documentation": "Number of records in this dataset."
|
||||
}
|
||||
},
|
||||
"documentation": "A collection of data for an identity pool.\n An identity pool can have multiple datasets. A dataset is per identity and can be general or\n associated with a particular entity in an application (like a saved game). Datasets are\n automatically created if they don't exist. Data is synced by dataset, and a dataset can hold\n up to 1MB of key-value pairs."
|
||||
}
|
||||
},
|
||||
"documentation": "Response to a successful DeleteDataset\n request."
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "NotAuthorizedException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n NotAuthorizedException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user is not authorized to access the\n requested resource."
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by\n InvalidParameterException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a request parameter does not comply\n with the associated constraints."
|
||||
},
|
||||
{
|
||||
"shape_name": "ResourceNotFoundException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by a\n ResourceNotFoundException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown if the resource doesn't\n exist."
|
||||
},
|
||||
{
|
||||
"shape_name": "InternalErrorException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by\n InternalErrorException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Indicates an internal service\n error."
|
||||
}
|
||||
],
|
||||
"documentation": "Deletes the specific dataset. The dataset will be deleted\n permanently, and the action can't be undone. Datasets that this dataset was merged with will\n no longer report the merge. Any consequent operation on this dataset will result in a\n ResourceNotFoundException."
|
||||
},
|
||||
"DescribeDataset": {
|
||||
"name": "DescribeDataset",
|
||||
"http": {
|
||||
"method": "GET",
|
||||
"uri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}",
|
||||
"response_code": 200
|
||||
},
|
||||
"input": {
|
||||
"shape_name": "DescribeDatasetRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
},
|
||||
"IdentityId": {
|
||||
"shape_name": "IdentityId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
},
|
||||
"DatasetName": {
|
||||
"shape_name": "DatasetName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[a-zA-Z0-9_.:-]+",
|
||||
"documentation": "A string of up to 128 characters.\n Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.'\n (dot).",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
}
|
||||
},
|
||||
"documentation": "A request for metadata about a dataset (creation\n date, number of records, size) by owner and dataset name."
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "DescribeDatasetResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Dataset": {
|
||||
"shape_name": "Dataset",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityId": {
|
||||
"shape_name": "IdentityId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region."
|
||||
},
|
||||
"DatasetName": {
|
||||
"shape_name": "DatasetName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[a-zA-Z0-9_.:-]+",
|
||||
"documentation": "A string of up to 128 characters. Allowed characters\n are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)."
|
||||
},
|
||||
"CreationDate": {
|
||||
"shape_name": "Date",
|
||||
"type": "timestamp",
|
||||
"documentation": "Date."
|
||||
},
|
||||
"LastModifiedDate": {
|
||||
"shape_name": "Date",
|
||||
"type": "timestamp",
|
||||
"documentation": "Date when the dataset was last\n modified."
|
||||
},
|
||||
"LastModifiedBy": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The device that made the last change to this\n dataset."
|
||||
},
|
||||
"DataStorage": {
|
||||
"shape_name": "Long",
|
||||
"type": "long",
|
||||
"documentation": "Total size in bytes of the records in this\n dataset."
|
||||
},
|
||||
"NumRecords": {
|
||||
"shape_name": "Long",
|
||||
"type": "long",
|
||||
"documentation": "Number of records in this dataset."
|
||||
}
|
||||
},
|
||||
"documentation": "Metadata for a collection of data for an\n identity. An identity can have multiple datasets. A dataset can be general or associated with\n a particular entity in an application (like a saved game). Datasets are automatically created\n if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value\n pairs."
|
||||
}
|
||||
},
|
||||
"documentation": "Response to a successful DescribeDataset\n request."
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "NotAuthorizedException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n NotAuthorizedException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user is not authorized to access the\n requested resource."
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by\n InvalidParameterException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a request parameter does not comply\n with the associated constraints."
|
||||
},
|
||||
{
|
||||
"shape_name": "ResourceNotFoundException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by a\n ResourceNotFoundException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown if the resource doesn't\n exist."
|
||||
},
|
||||
{
|
||||
"shape_name": "InternalErrorException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by\n InternalErrorException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Indicates an internal service\n error."
|
||||
}
|
||||
],
|
||||
"documentation": "Gets metadata about a dataset by identity and dataset\n name. "
|
||||
},
|
||||
"DescribeIdentityPoolUsage": {
|
||||
"name": "DescribeIdentityPoolUsage",
|
||||
"http": {
|
||||
"method": "GET",
|
||||
"uri": "/identitypools/{IdentityPoolId}",
|
||||
"response_code": 200
|
||||
},
|
||||
"input": {
|
||||
"shape_name": "DescribeIdentityPoolUsageRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for\n example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID\n generation is unique within a region.",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
}
|
||||
},
|
||||
"documentation": "A request for usage information about\n the identity pool."
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "DescribeIdentityPoolUsageResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolUsage": {
|
||||
"shape_name": "IdentityPoolUsage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region."
|
||||
},
|
||||
"SyncSessionsCount": {
|
||||
"shape_name": "Long",
|
||||
"type": "long",
|
||||
"documentation": "Number of sync sessions for the\n identity pool."
|
||||
},
|
||||
"DataStorage": {
|
||||
"shape_name": "Long",
|
||||
"type": "long",
|
||||
"documentation": "Data storage information for the identity\n pool."
|
||||
},
|
||||
"LastModifiedDate": {
|
||||
"shape_name": "Date",
|
||||
"type": "timestamp",
|
||||
"documentation": "Date on which the identity pool was\n last modified."
|
||||
}
|
||||
},
|
||||
"documentation": "Information about the\n usage of the identity pool."
|
||||
}
|
||||
},
|
||||
"documentation": "Response to a successful\n DescribeIdentityPoolUsage request."
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "NotAuthorizedException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n NotAuthorizedException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user is not authorized to access the\n requested resource."
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by\n InvalidParameterException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a request parameter does not comply\n with the associated constraints."
|
||||
},
|
||||
{
|
||||
"shape_name": "ResourceNotFoundException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by a\n ResourceNotFoundException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown if the resource doesn't\n exist."
|
||||
},
|
||||
{
|
||||
"shape_name": "InternalErrorException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by\n InternalErrorException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Indicates an internal service\n error."
|
||||
}
|
||||
],
|
||||
"documentation": "Gets usage details (for example, data storage) about\n a particular identity pool."
|
||||
},
|
||||
"DescribeIdentityUsage": {
|
||||
"name": "DescribeIdentityUsage",
|
||||
"http": {
|
||||
"method": "GET",
|
||||
"uri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}",
|
||||
"response_code": 200
|
||||
},
|
||||
"input": {
|
||||
"shape_name": "DescribeIdentityUsageRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for\n example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID\n generation is unique within a region.",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
},
|
||||
"IdentityId": {
|
||||
"shape_name": "IdentityId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
}
|
||||
},
|
||||
"documentation": "A request for information about the usage of\n an identity pool."
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "DescribeIdentityUsageResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityUsage": {
|
||||
"shape_name": "IdentityUsage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityId": {
|
||||
"shape_name": "IdentityId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region."
|
||||
},
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region."
|
||||
},
|
||||
"LastModifiedDate": {
|
||||
"shape_name": "Date",
|
||||
"type": "timestamp",
|
||||
"documentation": "Date on which the identity was last\n modified."
|
||||
},
|
||||
"DatasetCount": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "Number of datasets for the\n identity."
|
||||
},
|
||||
"DataStorage": {
|
||||
"shape_name": "Long",
|
||||
"type": "long",
|
||||
"documentation": "Total data storage for this\n identity."
|
||||
}
|
||||
},
|
||||
"documentation": "Usage information for the\n identity."
|
||||
}
|
||||
},
|
||||
"documentation": "The response to a successful\n DescribeIdentityUsage request."
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "NotAuthorizedException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n NotAuthorizedException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user is not authorized to access the\n requested resource."
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by\n InvalidParameterException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a request parameter does not comply\n with the associated constraints."
|
||||
},
|
||||
{
|
||||
"shape_name": "ResourceNotFoundException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by a\n ResourceNotFoundException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown if the resource doesn't\n exist."
|
||||
},
|
||||
{
|
||||
"shape_name": "InternalErrorException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by\n InternalErrorException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Indicates an internal service\n error."
|
||||
}
|
||||
],
|
||||
"documentation": "Gets usage information for an identity, including\n number of datasets and data usage. "
|
||||
},
|
||||
"ListDatasets": {
|
||||
"name": "ListDatasets",
|
||||
"http": {
|
||||
"method": "GET",
|
||||
"uri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets?maxResults={MaxResults}&nextToken={NextToken}",
|
||||
"response_code": 200
|
||||
},
|
||||
"input": {
|
||||
"shape_name": "ListDatasetsRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.",
|
||||
"location": "uri"
|
||||
},
|
||||
"IdentityId": {
|
||||
"shape_name": "IdentityId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
},
|
||||
"NextToken": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "A pagination token for obtaining the next\n page of results. ",
|
||||
"location": "uri"
|
||||
},
|
||||
"MaxResults": {
|
||||
"shape_name": "IntegerString",
|
||||
"type": "integer",
|
||||
"documentation": "The maximum number of results to be\n returned.",
|
||||
"location": "uri"
|
||||
}
|
||||
},
|
||||
"documentation": "Request for a list of datasets for an\n identity."
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ListDatasetsResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Datasets": {
|
||||
"shape_name": "DatasetList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Dataset",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityId": {
|
||||
"shape_name": "IdentityId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region."
|
||||
},
|
||||
"DatasetName": {
|
||||
"shape_name": "DatasetName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[a-zA-Z0-9_.:-]+",
|
||||
"documentation": "A string of up to 128 characters. Allowed characters\n are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)."
|
||||
},
|
||||
"CreationDate": {
|
||||
"shape_name": "Date",
|
||||
"type": "timestamp",
|
||||
"documentation": "Date."
|
||||
},
|
||||
"LastModifiedDate": {
|
||||
"shape_name": "Date",
|
||||
"type": "timestamp",
|
||||
"documentation": "Date when the dataset was last\n modified."
|
||||
},
|
||||
"LastModifiedBy": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The device that made the last change to this\n dataset."
|
||||
},
|
||||
"DataStorage": {
|
||||
"shape_name": "Long",
|
||||
"type": "long",
|
||||
"documentation": "Total size in bytes of the records in this\n dataset."
|
||||
},
|
||||
"NumRecords": {
|
||||
"shape_name": "Long",
|
||||
"type": "long",
|
||||
"documentation": "Number of records in this dataset."
|
||||
}
|
||||
},
|
||||
"documentation": "A collection of data for an identity pool. An identity pool can\n have multiple datasets. A dataset is per identity and can be general or associated with a\n particular entity in an application (like a saved game). Datasets are automatically created if\n they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value\n pairs."
|
||||
},
|
||||
"documentation": "A set of datasets."
|
||||
},
|
||||
"Count": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "Number of datasets returned."
|
||||
},
|
||||
"NextToken": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "A pagination token for obtaining the next\n page of results."
|
||||
}
|
||||
},
|
||||
"documentation": "Returned for a successful ListDatasets\n request."
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "NotAuthorizedException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n NotAuthorizedException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user is not authorized to access the\n requested resource."
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by\n InvalidParameterException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a request parameter does not comply\n with the associated constraints."
|
||||
},
|
||||
{
|
||||
"shape_name": "InternalErrorException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by\n InternalErrorException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Indicates an internal service\n error."
|
||||
}
|
||||
],
|
||||
"documentation": "Lists datasets for an identity."
|
||||
},
|
||||
"ListIdentityPoolUsage": {
|
||||
"name": "ListIdentityPoolUsage",
|
||||
"http": {
|
||||
"method": "GET",
|
||||
"uri": "/identitypools?maxResults={MaxResults}&nextToken={NextToken}",
|
||||
"response_code": 200
|
||||
},
|
||||
"input": {
|
||||
"shape_name": "ListIdentityPoolUsageRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"NextToken": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "A pagination token for obtaining\n the next page of results. ",
|
||||
"location": "uri"
|
||||
},
|
||||
"MaxResults": {
|
||||
"shape_name": "IntegerString",
|
||||
"type": "integer",
|
||||
"documentation": "The maximum number of results to\n be returned.",
|
||||
"location": "uri"
|
||||
}
|
||||
},
|
||||
"documentation": "A request for usage information on an\n identity pool."
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ListIdentityPoolUsageResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolUsages": {
|
||||
"shape_name": "IdentityPoolUsageList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "IdentityPoolUsage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region."
|
||||
},
|
||||
"SyncSessionsCount": {
|
||||
"shape_name": "Long",
|
||||
"type": "long",
|
||||
"documentation": "Number of sync sessions for the\n identity pool."
|
||||
},
|
||||
"DataStorage": {
|
||||
"shape_name": "Long",
|
||||
"type": "long",
|
||||
"documentation": "Data storage information for the identity\n pool."
|
||||
},
|
||||
"LastModifiedDate": {
|
||||
"shape_name": "Date",
|
||||
"type": "timestamp",
|
||||
"documentation": "Date on which the identity pool was\n last modified."
|
||||
}
|
||||
},
|
||||
"documentation": "Usage information for the identity\n pool."
|
||||
},
|
||||
"documentation": "Usage information for\n the identity pools."
|
||||
},
|
||||
"MaxResults": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "The maximum number of results to\n be returned."
|
||||
},
|
||||
"Count": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "Total number of identities for the\n identity pool."
|
||||
},
|
||||
"NextToken": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "A pagination token for obtaining\n the next page of results."
|
||||
}
|
||||
},
|
||||
"documentation": "Returned for a successful\n ListIdentityPoolUsage request."
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "NotAuthorizedException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n NotAuthorizedException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user is not authorized to access the\n requested resource."
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by\n InvalidParameterException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a request parameter does not comply\n with the associated constraints."
|
||||
},
|
||||
{
|
||||
"shape_name": "InternalErrorException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by\n InternalErrorException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Indicates an internal service\n error."
|
||||
}
|
||||
],
|
||||
"documentation": "Gets a list of identity pools registered with\n Cognito."
|
||||
},
|
||||
"ListRecords": {
|
||||
"name": "ListRecords",
|
||||
"http": {
|
||||
"method": "GET",
|
||||
"uri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/records?lastSyncCount={LastSyncCount}&maxResults={MaxResults}&nextToken={NextToken}&syncSessionToken={SyncSessionToken}",
|
||||
"response_code": 200
|
||||
},
|
||||
"input": {
|
||||
"shape_name": "ListRecordsRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
},
|
||||
"IdentityId": {
|
||||
"shape_name": "IdentityId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
},
|
||||
"DatasetName": {
|
||||
"shape_name": "DatasetName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[a-zA-Z0-9_.:-]+",
|
||||
"documentation": "A string of up to 128 characters. Allowed\n characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
},
|
||||
"LastSyncCount": {
|
||||
"shape_name": "IntegerString",
|
||||
"type": "long",
|
||||
"documentation": "The last server sync count for this record.",
|
||||
"location": "uri"
|
||||
},
|
||||
"NextToken": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "A pagination token for obtaining the next\n page of results.",
|
||||
"location": "uri"
|
||||
},
|
||||
"MaxResults": {
|
||||
"shape_name": "IntegerString",
|
||||
"type": "integer",
|
||||
"documentation": "The maximum number of results to be\n returned.",
|
||||
"location": "uri"
|
||||
},
|
||||
"SyncSessionToken": {
|
||||
"shape_name": "SyncSessionToken",
|
||||
"type": "string",
|
||||
"documentation": "A token containing a session ID, identity ID, and expiration.",
|
||||
"location": "uri"
|
||||
}
|
||||
},
|
||||
"documentation": "A request for a list of records."
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ListRecordsResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Records": {
|
||||
"shape_name": "RecordList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Record",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Key": {
|
||||
"shape_name": "RecordKey",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 1024,
|
||||
"documentation": "The key for the record."
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "RecordValue",
|
||||
"type": "string",
|
||||
"max_length": 1048575,
|
||||
"documentation": "The value for the record."
|
||||
},
|
||||
"SyncCount": {
|
||||
"shape_name": "Long",
|
||||
"type": "long",
|
||||
"documentation": "The server sync count for this record."
|
||||
},
|
||||
"LastModifiedDate": {
|
||||
"shape_name": "Date",
|
||||
"type": "timestamp",
|
||||
"documentation": "The date on which the record was last\n modified."
|
||||
},
|
||||
"LastModifiedBy": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The user/device that made the last change to this\n record."
|
||||
},
|
||||
"DeviceLastModifiedDate": {
|
||||
"shape_name": "Date",
|
||||
"type": "timestamp",
|
||||
"documentation": "The last modified date of the client device."
|
||||
}
|
||||
},
|
||||
"documentation": "The basic data structure of a dataset."
|
||||
},
|
||||
"documentation": "A list of all records."
|
||||
},
|
||||
"NextToken": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "A pagination token for obtaining the next\n page of results."
|
||||
},
|
||||
"Count": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "Total number of records."
|
||||
},
|
||||
"DatasetSyncCount": {
|
||||
"shape_name": "Long",
|
||||
"type": "long",
|
||||
"documentation": "Server sync count for this dataset."
|
||||
},
|
||||
"LastModifiedBy": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
},
|
||||
"MergedDatasetNames": {
|
||||
"shape_name": "MergedDatasetNameList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "Names of merged\n datasets."
|
||||
},
|
||||
"DatasetExists": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "Indicates whether the dataset\n exists."
|
||||
},
|
||||
"DatasetDeletedAfterRequestedSyncCount": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "A boolean value\n specifying whether to delete the dataset locally."
|
||||
},
|
||||
"SyncSessionToken": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "A token containing a session ID, identity ID, and expiration."
|
||||
}
|
||||
},
|
||||
"documentation": "Returned for a successful\n ListRecordsRequest."
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidParameterException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by\n InvalidParameterException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a request parameter does not comply\n with the associated constraints."
|
||||
},
|
||||
{
|
||||
"shape_name": "NotAuthorizedException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n NotAuthorizedException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user is not authorized to access the\n requested resource."
|
||||
},
|
||||
{
|
||||
"shape_name": "TooManyRequestsException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by a\n TooManyRequestsException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown if the request is\n throttled."
|
||||
},
|
||||
{
|
||||
"shape_name": "InternalErrorException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by\n InternalErrorException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Indicates an internal service\n error."
|
||||
}
|
||||
],
|
||||
"documentation": "Gets paginated records, optionally changed after a particular\n sync count for a dataset and identity."
|
||||
},
|
||||
"UpdateRecords": {
|
||||
"name": "UpdateRecords",
|
||||
"http": {
|
||||
"method": "POST",
|
||||
"uri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}",
|
||||
"response_code": 200
|
||||
},
|
||||
"input": {
|
||||
"shape_name": "UpdateRecordsRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IdentityPoolId": {
|
||||
"shape_name": "IdentityPoolId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
},
|
||||
"IdentityId": {
|
||||
"shape_name": "IdentityId",
|
||||
"type": "string",
|
||||
"pattern": "[\\w-]+:[0-9a-f-]+",
|
||||
"min_length": 1,
|
||||
"max_length": 50,
|
||||
"documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
},
|
||||
"DatasetName": {
|
||||
"shape_name": "DatasetName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"pattern": "[a-zA-Z0-9_.:-]+",
|
||||
"documentation": "A string of up to 128 characters.\n Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.'\n (dot).",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
},
|
||||
"RecordPatches": {
|
||||
"shape_name": "RecordPatchList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "RecordPatch",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Op": {
|
||||
"shape_name": "Operation",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"replace",
|
||||
"remove"
|
||||
],
|
||||
"documentation": "An operation, either replace or remove.",
|
||||
"required": true
|
||||
},
|
||||
"Key": {
|
||||
"shape_name": "RecordKey",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 1024,
|
||||
"documentation": "The key associated with the record patch.",
|
||||
"required": true
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "RecordValue",
|
||||
"type": "string",
|
||||
"max_length": 1048575,
|
||||
"documentation": "The value associated with the record\n patch."
|
||||
},
|
||||
"SyncCount": {
|
||||
"shape_name": "Long",
|
||||
"type": "long",
|
||||
"documentation": "Last known server sync count for this record. Set to 0 if unknown.",
|
||||
"required": true
|
||||
},
|
||||
"DeviceLastModifiedDate": {
|
||||
"shape_name": "Date",
|
||||
"type": "timestamp",
|
||||
"documentation": "The last modified date of the client device."
|
||||
}
|
||||
},
|
||||
"documentation": "An update operation for a record."
|
||||
},
|
||||
"documentation": " "
|
||||
},
|
||||
"SyncSessionToken": {
|
||||
"shape_name": "SyncSessionToken",
|
||||
"type": "string",
|
||||
"documentation": "The SyncSessionToken returned by a\n previous call to ListRecords for this dataset and identity.",
|
||||
"required": true
|
||||
},
|
||||
"ClientContext": {
|
||||
"shape_name": "ClientContext",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"location": "header",
|
||||
"location_name": "x-amz-Client-Context"
|
||||
}
|
||||
},
|
||||
"documentation": "A request to post updates to records or add and\n delete records for a dataset and user."
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "UpdateRecordsResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Records": {
|
||||
"shape_name": "RecordList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Record",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Key": {
|
||||
"shape_name": "RecordKey",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 1024,
|
||||
"documentation": "The key for the record."
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "RecordValue",
|
||||
"type": "string",
|
||||
"max_length": 1048575,
|
||||
"documentation": "The value for the record."
|
||||
},
|
||||
"SyncCount": {
|
||||
"shape_name": "Long",
|
||||
"type": "long",
|
||||
"documentation": "The server sync count for this record."
|
||||
},
|
||||
"LastModifiedDate": {
|
||||
"shape_name": "Date",
|
||||
"type": "timestamp",
|
||||
"documentation": "The date on which the record was last\n modified."
|
||||
},
|
||||
"LastModifiedBy": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "The user/device that made the last change to this\n record."
|
||||
},
|
||||
"DeviceLastModifiedDate": {
|
||||
"shape_name": "Date",
|
||||
"type": "timestamp",
|
||||
"documentation": "The last modified date of the client device."
|
||||
}
|
||||
},
|
||||
"documentation": "The basic data structure of a dataset."
|
||||
},
|
||||
"documentation": "A list of records that have been\n updated."
|
||||
}
|
||||
},
|
||||
"documentation": "Returned for a successful\n UpdateRecordsRequest."
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidParameterException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by\n InvalidParameterException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a request parameter does not comply\n with the associated constraints."
|
||||
},
|
||||
{
|
||||
"shape_name": "LimitExceededException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by\n LimitExceededException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when the limit on the number of objects or\n operations has been exceeded."
|
||||
},
|
||||
{
|
||||
"shape_name": "NotAuthorizedException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n NotAuthorizedException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown when a user is not authorized to access the\n requested resource."
|
||||
},
|
||||
{
|
||||
"shape_name": "ResourceNotFoundException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by a\n ResourceNotFoundException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown if the resource doesn't\n exist."
|
||||
},
|
||||
{
|
||||
"shape_name": "ResourceConflictException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "The message returned by a\n ResourceConflictException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown if an update can't be applied because\n the resource was changed by another call and this would result in a conflict."
|
||||
},
|
||||
{
|
||||
"shape_name": "TooManyRequestsException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by a\n TooManyRequestsException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Thrown if the request is\n throttled."
|
||||
},
|
||||
{
|
||||
"shape_name": "InternalErrorException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": "Message returned by\n InternalErrorException.",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "Indicates an internal service\n error."
|
||||
}
|
||||
],
|
||||
"documentation": "Posts updates to records and add and delete records for a\n dataset and user."
|
||||
}
|
||||
},
|
||||
"retry": {
|
||||
"__default__": {
|
||||
"max_attempts": 5,
|
||||
"delay": {
|
||||
"type": "exponential",
|
||||
"base": "rand",
|
||||
"growth_factor": 2
|
||||
},
|
||||
"policies": {
|
||||
"general_socket_errors": {
|
||||
"applies_when": {
|
||||
"socket_errors": [
|
||||
"GENERAL_CONNECTION_ERROR"
|
||||
]
|
||||
}
|
||||
},
|
||||
"general_server_error": {
|
||||
"applies_when": {
|
||||
"response": {
|
||||
"http_status_code": 500
|
||||
}
|
||||
}
|
||||
},
|
||||
"service_unavailable": {
|
||||
"applies_when": {
|
||||
"response": {
|
||||
"http_status_code": 503
|
||||
}
|
||||
}
|
||||
},
|
||||
"limit_exceeded": {
|
||||
"applies_when": {
|
||||
"response": {
|
||||
"http_status_code": 509
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -4798,6 +4798,11 @@
|
|||
"output_token": "LastEvaluatedKey",
|
||||
"limit_key": "Limit",
|
||||
"result_key": "Items",
|
||||
"non_aggregate_keys": [
|
||||
"Count",
|
||||
"ScannedCount",
|
||||
"ConsumedCapacity"
|
||||
],
|
||||
"py_input_token": "exclusive_start_key"
|
||||
}
|
||||
},
|
||||
|
|
@ -5314,6 +5319,11 @@
|
|||
"output_token": "LastEvaluatedKey",
|
||||
"limit_key": "Limit",
|
||||
"result_key": "Items",
|
||||
"non_aggregate_keys": [
|
||||
"Count",
|
||||
"ScannedCount",
|
||||
"ConsumedCapacity"
|
||||
],
|
||||
"py_input_token": "exclusive_start_key"
|
||||
}
|
||||
},
|
||||
|
|
@ -6500,6 +6510,11 @@
|
|||
"output_token": "LastEvaluatedKey",
|
||||
"limit_key": "Limit",
|
||||
"result_key": "Items",
|
||||
"non_aggregate_keys": [
|
||||
"Count",
|
||||
"ScannedCount",
|
||||
"ConsumedCapacity"
|
||||
],
|
||||
"py_input_token": "exclusive_start_key"
|
||||
},
|
||||
"Scan": {
|
||||
|
|
@ -6507,6 +6522,11 @@
|
|||
"output_token": "LastEvaluatedKey",
|
||||
"limit_key": "Limit",
|
||||
"result_key": "Items",
|
||||
"non_aggregate_keys": [
|
||||
"Count",
|
||||
"ScannedCount",
|
||||
"ConsumedCapacity"
|
||||
],
|
||||
"py_input_token": "exclusive_start_key"
|
||||
}
|
||||
},
|
||||
|
|
|
|||
20936
botocore/data/aws/ec2/2014-06-15.json
Normal file
20936
botocore/data/aws/ec2/2014-06-15.json
Normal file
File diff suppressed because one or more lines are too long
|
|
@ -3332,6 +3332,9 @@
|
|||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "Parameters",
|
||||
"non_aggregate_keys": [
|
||||
"CacheNodeTypeSpecificParameters"
|
||||
],
|
||||
"py_input_token": "marker"
|
||||
}
|
||||
},
|
||||
|
|
@ -6467,6 +6470,9 @@
|
|||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "Parameters",
|
||||
"non_aggregate_keys": [
|
||||
"CacheNodeTypeSpecificParameters"
|
||||
],
|
||||
"py_input_token": "marker"
|
||||
},
|
||||
"DescribeCacheSecurityGroups": {
|
||||
|
|
|
|||
6639
botocore/data/aws/elasticache/2014-07-15.json
Normal file
6639
botocore/data/aws/elasticache/2014-07-15.json
Normal file
|
|
@ -0,0 +1,6639 @@
|
|||
{
|
||||
"api_version": "2014-07-15",
|
||||
"type": "query",
|
||||
"result_wrapped": true,
|
||||
"signature_version": "v4",
|
||||
"service_full_name": "Amazon ElastiCache",
|
||||
"endpoint_prefix": "elasticache",
|
||||
"xmlnamespace": "http://elasticache.amazonaws.com/doc/2014-07-15/",
|
||||
"documentation": "\n <fullname>Amazon ElastiCache</fullname>\n <p>Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a\n distributed cache in the cloud.</p>\n <p>With ElastiCache, customers gain all of the benefits of a high-performance, in-memory cache\n with far less of the administrative burden of launching and managing a distributed\n cache. The service makes set-up, scaling, and cluster failure handling much simpler than\n in a self-managed cache deployment.</p>\n <p>In addition, through integration with Amazon CloudWatch, customers get enhanced\n visibility into the key performance statistics associated with their cache and can\n receive alarms if a part of their cache runs hot.</p>\n ",
|
||||
"operations": {
|
||||
"AuthorizeCacheSecurityGroupIngress": {
|
||||
"name": "AuthorizeCacheSecurityGroupIngress",
|
||||
"input": {
|
||||
"shape_name": "AuthorizeCacheSecurityGroupIngressMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache security group which will allow network ingress.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"EC2SecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon EC2 security group to be authorized for ingress to the cache security\n group.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"EC2SecurityGroupOwnerId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The AWS account number of the Amazon EC2 security group owner. Note that this is not the\n same thing as an AWS access key ID - you must provide a valid AWS account number for\n this parameter.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of an <i>AuthorizeCacheSecurityGroupIngress</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CacheSecurityGroupWrapper",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSecurityGroup": {
|
||||
"shape_name": "CacheSecurityGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"OwnerId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The AWS account ID of the cache security group owner.</p>\n "
|
||||
},
|
||||
"CacheSecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache security group.</p>\n "
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The description of the cache security group.</p>\n "
|
||||
},
|
||||
"EC2SecurityGroups": {
|
||||
"shape_name": "EC2SecurityGroupList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "EC2SecurityGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the Amazon EC2 security group.</p>\n "
|
||||
},
|
||||
"EC2SecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Amazon EC2 security group.</p>\n "
|
||||
},
|
||||
"EC2SecurityGroupOwnerId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The AWS account ID of the Amazon EC2 security group owner.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Provides ownership and status information for an Amazon EC2 security group.</p>\n ",
|
||||
"xmlname": "EC2SecurityGroup"
|
||||
},
|
||||
"documentation": "\n <p>A list of Amazon EC2 security groups that are associated with this cache security\n group.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents the output of one of the following operations:</p>\n <ul>\n <li>\n <i>AuthorizeCacheSecurityGroupIngress</i>\n </li>\n <li>\n <i>CreateCacheSecurityGroup</i>\n </li>\n <li>\n <i>RevokeCacheSecurityGroupIngress</i>\n </li>\n </ul>\n "
|
||||
}
|
||||
}
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "CacheSecurityGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p> The requested cache security group name does not refer to an existing cache security\n group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidCacheSecurityGroupStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The current state of the cache security group does not allow deletion.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "AuthorizationAlreadyExistsFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The specified Amazon EC2 security group is already authorized for the specified cache\n security group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>AuthorizeCacheSecurityGroupIngress</i> operation allows network ingress to a cache\n security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2\n security groups are used as the authorization mechanism.</p>\n <note>You cannot authorize ingress from an Amazon EC2 security group in one region to an\n ElastiCache cluster in another region. </note>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=AuthorizeCacheSecurityGroupIngress\n &EC2SecurityGroupName=default\n &CacheSecurityGroupName=mygroup\n &EC2SecurityGroupOwnerId=1234-5678-1234\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse>\n<AuthorizeCacheSecurityGroupIngressResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <AuthorizeCacheSecurityGroupIngressResult>\n <CacheSecurityGroup>\n <EC2SecurityGroups>\n <EC2SecurityGroup>\n <Status>authorizing</Status>\n <EC2SecurityGroupName>default</EC2SecurityGroupName>\n <EC2SecurityGroupOwnerId>565419523791</EC2SecurityGroupOwnerId>\n </EC2SecurityGroup>\n </EC2SecurityGroups>\n <CacheSecurityGroupName>mygroup</CacheSecurityGroupName>\n <OwnerId>123456781234</OwnerId>\n <Description>My security group</Description>\n </CacheSecurityGroup>\n </AuthorizeCacheSecurityGroupIngressResult>\n <ResponseMetadata>\n <RequestId>817fa999-3647-11e0-ae57-f96cfe56749c</RequestId>\n </ResponseMetadata>\n</AuthorizeCacheSecurityGroupIngressResponse></queryresponse>\n </examples>\n "
|
||||
},
|
||||
"CopySnapshot": {
|
||||
"name": "CopySnapshot",
|
||||
"input": {
|
||||
"shape_name": "CopySnapshotMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"SourceSnapshotName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of an existing snapshot from which to copy.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"TargetSnapshotName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A name for the copied snapshot.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>CopySnapshotMessage</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "SnapshotWrapper",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Snapshot": {
|
||||
"shape_name": "Snapshot",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"SnapshotName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <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>\n "
|
||||
},
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The user-supplied identifier of the source cache cluster.</p>\n "
|
||||
},
|
||||
"SnapshotStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the snapshot. Valid values: <code>creating</code> | <code>available</code>\n | <code>restoring</code> | <code>copying</code> | <code>deleting</code>.</p>\n "
|
||||
},
|
||||
"SnapshotSource": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Indicates whether the snapshot is from an automatic backup (<code>automated</code>) or was created manually (<code>manual</code>).</p>\n "
|
||||
},
|
||||
"CacheNodeType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the compute and memory capacity node type for the source cache cluster.</p>\n "
|
||||
},
|
||||
"Engine": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache engine (<i>memcached</i> or <i>redis</i>) used by the source cache\n cluster.</p>\n "
|
||||
},
|
||||
"EngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The version of the cache engine version that is used by the source cache cluster.</p>\n "
|
||||
},
|
||||
"NumCacheNodes": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of cache nodes in the source cache cluster.</p>\n "
|
||||
},
|
||||
"PreferredAvailabilityZone": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Availability Zone in which the source cache cluster is located.</p>\n "
|
||||
},
|
||||
"CacheClusterCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the source cache cluster was created.</p>\n "
|
||||
},
|
||||
"PreferredMaintenanceWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p> The time range (in UTC) during which weekly system maintenance can occur on the source\n cache cluster.</p>\n "
|
||||
},
|
||||
"TopicArn": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon Resource Name (ARN) for the topic used by the source cache cluster for\n publishing notifications.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number used by each cache nodes in the source cache cluster.</p>\n "
|
||||
},
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache parameter group that is associated with the source cache cluster.</p>\n "
|
||||
},
|
||||
"CacheSubnetGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache subnet group associated with the source cache cluster.</p>\n "
|
||||
},
|
||||
"VpcId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the\n source cache cluster.</p>\n "
|
||||
},
|
||||
"AutoMinorVersionUpgrade": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>For the source cache cluster, indicates whether minor version patches are applied\n automatically (<code>true</code>) or not (<code>false</code>).</p>\n "
|
||||
},
|
||||
"SnapshotRetentionLimit": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.</p>\n <p>For manual snapshots, this field reflects the <i>SnapshotRetentionLimit</i> for the\n source cache cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the <i>DeleteSnapshot</i>\n action. </p>\n <p><b>Important</b><br>If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</p>\n "
|
||||
},
|
||||
"SnapshotWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The daily time range during which ElastiCache takes daily snapshots of the source cache\n cluster.</p>\n "
|
||||
},
|
||||
"NodeSnapshots": {
|
||||
"shape_name": "NodeSnapshotList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "NodeSnapshot",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache node identifier for the node in the source cache cluster.</p>\n "
|
||||
},
|
||||
"CacheSize": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The size of the cache on the source cache node.</p>\n "
|
||||
},
|
||||
"CacheNodeCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the cache node was created in the source cache cluster.</p>\n "
|
||||
},
|
||||
"SnapshotCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the source node's metadata and cache data set was obtained for the snapshot.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents an individual cache node in a snapshot of a cache cluster.</p>\n ",
|
||||
"xmlname": "NodeSnapshot"
|
||||
},
|
||||
"documentation": "\n <p>A list of the cache nodes in the source cache cluster.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents a copy of an entire cache cluster as of the time when the snapshot was taken.</p>\n "
|
||||
}
|
||||
}
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "SnapshotAlreadyExistsFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>You already have a snapshot with the given name.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "SnapshotNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested snapshot name does not refer to an existing snapshot.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "SnapshotQuotaExceededFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The request cannot be processed because it would exceed the maximum number of\n snapshots.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidSnapshotStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The current state of the snapshot does not allow the requested action to occur.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>CopySnapshot</i> operation makes a copy of an existing snapshot.</p>\n "
|
||||
},
|
||||
"CreateCacheCluster": {
|
||||
"name": "CreateCacheCluster",
|
||||
"input": {
|
||||
"shape_name": "CreateCacheClusterMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache cluster identifier. This parameter is stored as a lowercase string.</p>\n \n<p>Constraints:</p>\n<ul>\n<li>Must contain from 1 to 20 alphanumeric characters or hyphens.</li>\n<li>First character must be a letter.</li>\n<li>Cannot end with a hyphen or contain two consecutive hyphens.</li>\n</ul>\n ",
|
||||
"required": true
|
||||
},
|
||||
"ReplicationGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The replication group to which this cache cluster should belong. If this parameter is\n specified, the cache cluster will be added to the specified replication group as a read\n replica; otherwise, the cache cluster will be a standalone primary that is not part of\n any replication group.</p>\n "
|
||||
},
|
||||
"NumCacheNodes": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The initial number of cache nodes that the cache cluster will have.</p>\n <p>For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this\n limit, please fill out the ElastiCache Limit Increase Request form at <a href=\"http://aws.amazon.com/contact-us/elasticache-node-limit-request/\"></a> .</p>\n <p>For Redis, only single-node cache clusters are supported at this time, so the value for\n this parameter must be 1.</p>\n "
|
||||
},
|
||||
"CacheNodeType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The compute and memory capacity of the nodes in the cache cluster.</p>\n \n<p><b>Valid cache types</b></p>\n<ul>\n <li>Micro<p><code>cache.t1.micro | cache.m1.small</code></p></li>\n <li>General Purpose\n <ul>\n <li>Current Generation<p><code>cache.m3.medium | cache.m3.large | cache.m3.xlarge | cache.m3.2xlarge</code></p></li>\n <li>Previous Generation<p><code>cache.m1.medium | cache.m1.large | cache.m1.xlarge</code></p></li>\n </ul></li>\n <li>Compute Optimized<p><code>cache.c1.xlarge</code></p></li>\n <li>Memory Optimized\n <ul>\n <li>Current Generation<p><code>cache.r3.large | cache.r3.xlarge | cache.r3.2xlarge | cache.r3.4xlarge | cache.r3.8xlarge</code></p></li>\n <li>Previous Generation<p><code>cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge</code></p></li>\n </ul></li>\n</ul>\n<p>For a complete listing of cache node types and specifications, \nsee <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Memcached.html#CacheParameterGroups.Memcached.NodeSpecific\">Cache Node Type-Specific Parameters for Memcached</a>\nor <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheParameterGroups.Redis.html#CacheParameterGroups.Redis.NodeSpecific\">Cache Node Type-Specific Parameters for Redis</a> \nand <a href=\"http://aws.amazon.com/elasticache/details\">Amazon ElastiCache Product Features and Details</a>.</p>\n "
|
||||
},
|
||||
"Engine": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache engine to be used for this cache cluster.</p>\n <p>Valid values for this parameter are:</p>\n <p><code>memcached</code> | <code>redis</code></p>\n "
|
||||
},
|
||||
"EngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The version number of the cache engine to be used for this cluster. To view the supported\n cache engine versions, use the <i>DescribeCacheEngineVersions</i> operation.</p>\n "
|
||||
},
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group to associate with this cache cluster. If this\n argument is omitted, the default cache parameter group for the specified engine will be\n used.</p>\n "
|
||||
},
|
||||
"CacheSubnetGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache subnet group to be used for the cache cluster.</p>\n <p>Use this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (VPC).</p>\n "
|
||||
},
|
||||
"CacheSecurityGroupNames": {
|
||||
"shape_name": "CacheSecurityGroupNameList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "CacheSecurityGroupName"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache security group names to associate with this cache cluster.</p>\n <p>Use this parameter only when you are creating a cluster outside of an Amazon Virtual\n Private Cloud (VPC).</p>\n "
|
||||
},
|
||||
"SecurityGroupIds": {
|
||||
"shape_name": "SecurityGroupIdsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "SecurityGroupId"
|
||||
},
|
||||
"documentation": "\n <p>One or more VPC security groups associated with the cache cluster.</p>\n <p>Use this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (VPC).</p>\n "
|
||||
},
|
||||
"SnapshotArns": {
|
||||
"shape_name": "SnapshotArnsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "SnapshotArn"
|
||||
},
|
||||
"documentation": "\n <p>A single-element string list containing an Amazon Resource Name (ARN) that uniquely\n identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file will be used\n to populate the Redis cache in the new cache cluster. The Amazon S3 object name in the\n ARN cannot contain any commas.</p>\n\n <p>Here is an example of an Amazon S3 ARN:\n <code>arn:aws:s3:::my_bucket/snapshot1.rdb</code></p>\n\n <p><b>Note:</b> This parameter is only valid if the <code>Engine</code> parameter is\n <code>redis</code>.</p>\n "
|
||||
},
|
||||
"SnapshotName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of a snapshot from which to restore data into the new cache cluster. The\n snapshot's status changes to <code>restoring</code> while the new cache cluster is being\n created.</p>\n "
|
||||
},
|
||||
"AZMode": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Specifies whether the nodes in this Memcached cache cluster are created in a single Availability Zone or \n created across multiple Availability Zones.</p>\n <p>This option is only supported for Memcached cache clusters.</p>\n <note>If the <code>AZMode</code> and <code>PreferredAvailabilityZones</code> are not specified, ElastiCache assumes <code>single-az</code> mode.</note>\n <p>Valid values: <code>single-az</code> | <code>cross-az</code>.</p>\n "
|
||||
},
|
||||
"PreferredAvailabilityZone": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The EC2 Availability Zone in which the cache cluster will be created.</p>\n <p>All cache nodes belonging to this Memcached cache cluster are placed in the preferred Availability Zone. \n If you want to create your cache nodes across multiple Availability Zones, use <code>PreferredAvailabilityZones</code>.</p>\n <p>Default: System chosen Availability Zone.</p>\n "
|
||||
},
|
||||
"PreferredAvailabilityZones": {
|
||||
"shape_name": "PreferredAvailabilityZoneList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "PreferredAvailabilityZone"
|
||||
},
|
||||
"documentation": "\n <p>A list of the Availability Zones in which nodes will be created. The order of the zones in the list is not important.</p>\n <p>This option is only supported on Memcached clusters.</p>\n <note>\n <p>If you are creating your cache cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones \n that are associated with the subnets in the selected subnet group.</p>\n <p>The number of Availability Zones listed must equal the value of <code>NumCacheNodes</code>.</p>\n </note>\n <p>If you want all your cache nodes in the same Availability Zone, use <code>PreferredAvailabilityZone</code> instead or \n repeat the Availability Zone multiple times in the list.</p>\n <p>Default: System chosen Availability Zones.</p>\n <p>Example: One Memcached node in each of three Availability Zones: <code>PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1b&PreferredAvailabilityZones.member.3=us-east-1d</code></p>\n <p>Example: All three Memcached nodes in one Availability Zone: <code>PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1a&PreferredAvailabilityZones.member.3=us-east-1a</code></p>\n "
|
||||
},
|
||||
"PreferredMaintenanceWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The weekly time range (in UTC) during which system maintenance can occur.</p>\n <p>Example: <code>sun:05:00-sun:09:00</code>\n </p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number on which each of the cache nodes will accept connections.</p>\n "
|
||||
},
|
||||
"NotificationTopicArn": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to\n which notifications will be sent.</p>\n <note>The Amazon SNS topic owner must be the same as the cache cluster owner. </note>\n "
|
||||
},
|
||||
"AutoMinorVersionUpgrade": {
|
||||
"shape_name": "BooleanOptional",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Determines whether minor engine upgrades will be applied automatically to the cache\n cluster during the maintenance window. A value of <code>true</code> allows these\n upgrades to occur; <code>false</code> disables automatic upgrades.</p>\n <p>Default: <code>true</code></p>\n "
|
||||
},
|
||||
"SnapshotRetentionLimit": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set <code>SnapshotRetentionLimit</code> to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.</p>\n <p>If you do not specify this parameter, then <code>SnapshotRetentionLimit</code> will be set to 0 (i.e., automatic backups will be disabled for this cache cluster).</p>\n "
|
||||
},
|
||||
"SnapshotWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.</p>\n <p>Example: <code>05:00-09:00</code></p>\n <p>If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>CreateCacheCluster</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CacheClusterWrapper",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheCluster": {
|
||||
"shape_name": "CacheCluster",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The user-supplied identifier of the cache cluster. This is a unique key that identifies a\n cache cluster.</p>\n "
|
||||
},
|
||||
"ConfigurationEndpoint": {
|
||||
"shape_name": "Endpoint",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Address": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The DNS hostname of the cache node.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number that the cache engine is listening on.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the information required for client programs to connect to a cache node.</p>\n "
|
||||
},
|
||||
"ClientDownloadLandingPage": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The URL of the web page where you can download the latest ElastiCache client library.</p>\n "
|
||||
},
|
||||
"CacheNodeType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the compute and memory capacity node type for the cache cluster.</p>\n "
|
||||
},
|
||||
"Engine": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache engine (<i>memcached</i> or <i>redis</i>) to be used for this cache\n cluster.</p>\n "
|
||||
},
|
||||
"EngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The version of the cache engine version that is used in this cache cluster.</p>\n "
|
||||
},
|
||||
"CacheClusterStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of this cache cluster - <i>creating</i>, <i>available</i>, etc.</p>\n "
|
||||
},
|
||||
"NumCacheNodes": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of cache nodes in the cache cluster.</p>\n "
|
||||
},
|
||||
"PreferredAvailabilityZone": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Availability Zone in which the cache cluster is located or \n \"Multiple\" if the cache nodes are located in different Availability Zones.</p>\n "
|
||||
},
|
||||
"CacheClusterCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the cache cluster was created.</p>\n "
|
||||
},
|
||||
"PreferredMaintenanceWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The time range (in UTC) during which weekly system maintenance can occur.</p>\n "
|
||||
},
|
||||
"PendingModifiedValues": {
|
||||
"shape_name": "PendingModifiedValues",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"NumCacheNodes": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The new number of cache nodes for the cache cluster.</p>\n "
|
||||
},
|
||||
"CacheNodeIdsToRemove": {
|
||||
"shape_name": "CacheNodeIdsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "CacheNodeId"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache node IDs that are being removed (or will be removed) from the cache\n cluster. A node ID is a numeric identifier (0001, 0002, etc.).</p>\n "
|
||||
},
|
||||
"EngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The new cache engine version that the cache cluster will run.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A group of settings that will be applied to the cache cluster in the future, or that are\n currently being applied.</p>\n "
|
||||
},
|
||||
"NotificationConfiguration": {
|
||||
"shape_name": "NotificationConfiguration",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"TopicArn": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon Resource Name (ARN) that identifies the topic.</p>\n "
|
||||
},
|
||||
"TopicStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of the topic.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Describes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).</p>\n "
|
||||
},
|
||||
"CacheSecurityGroups": {
|
||||
"shape_name": "CacheSecurityGroupMembershipList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "CacheSecurityGroupMembership",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache security group.</p>\n "
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents a cache cluster's status within a particular cache security group.</p>\n ",
|
||||
"xmlname": "CacheSecurityGroup"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache security group elements, composed of name and status sub-elements.</p>\n "
|
||||
},
|
||||
"CacheParameterGroup": {
|
||||
"shape_name": "CacheParameterGroupStatus",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group.</p>\n "
|
||||
},
|
||||
"ParameterApplyStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of parameter updates.</p>\n "
|
||||
},
|
||||
"CacheNodeIdsToReboot": {
|
||||
"shape_name": "CacheNodeIdsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "CacheNodeId"
|
||||
},
|
||||
"documentation": "\n <p>A list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The status of the cache parameter group.</p>\n "
|
||||
},
|
||||
"CacheSubnetGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache subnet group associated with the cache cluster.</p>\n "
|
||||
},
|
||||
"CacheNodes": {
|
||||
"shape_name": "CacheNodeList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "CacheNode",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.</p>\n "
|
||||
},
|
||||
"CacheNodeStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of this cache node.</p>\n "
|
||||
},
|
||||
"CacheNodeCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the cache node was created.</p>\n "
|
||||
},
|
||||
"Endpoint": {
|
||||
"shape_name": "Endpoint",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Address": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The DNS hostname of the cache node.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number that the cache engine is listening on.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The hostname and IP address for connecting to this cache node.</p>\n "
|
||||
},
|
||||
"ParameterGroupStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the parameter group applied to this cache node.</p>\n "
|
||||
},
|
||||
"SourceCacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of the primary node to which this read replica node is synchronized. If this field\n is empty, then this node is not associated with a primary cache cluster.</p>\n "
|
||||
},
|
||||
"CustomerAvailabilityZone": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Availability Zone where this node was created and now resides.</p> \n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.</p>\n ",
|
||||
"xmlname": "CacheNode"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache nodes that are members of the cache cluster.</p>\n "
|
||||
},
|
||||
"AutoMinorVersionUpgrade": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>If <code>true</code>, then minor version patches are applied automatically; if\n <code>false</code>, then automatic minor version patches are disabled.</p>\n "
|
||||
},
|
||||
"SecurityGroups": {
|
||||
"shape_name": "SecurityGroupMembershipList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "SecurityGroupMembership",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"SecurityGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier of the cache security group.</p>\n "
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents a single cache security group and its status..</p>\n "
|
||||
},
|
||||
"documentation": "\n <p>A list of VPC Security Groups associated with the cache cluster.</p>\n "
|
||||
},
|
||||
"ReplicationGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.</p>\n "
|
||||
},
|
||||
"SnapshotRetentionLimit": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set <i>SnapshotRetentionLimit</i> to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.</p>\n <p><b>Important</b><br>If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</p>\n "
|
||||
},
|
||||
"SnapshotWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.</p>\n <p>Example: <code>05:00-09:00</code></p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Contains all of the attributes of a specific cache cluster.</p>\n "
|
||||
}
|
||||
}
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "ReplicationGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The specified replication group does not exist.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidReplicationGroupStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested replication group is not in the <i>available</i> state.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheClusterAlreadyExistsFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>You already have a cache cluster with the given identifier.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InsufficientCacheClusterCapacityFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache node type is not available in the specified Availability Zone.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheSecurityGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p> The requested cache security group name does not refer to an existing cache security\n group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheSubnetGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache subnet group name does not refer to an existing cache subnet\n group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "ClusterQuotaForCustomerExceededFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The request cannot be processed because it would exceed the allowed number of cache\n clusters per customer.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "NodeQuotaForClusterExceededFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The request cannot be processed because it would exceed the allowed number of cache nodes\n in a single cache cluster.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "NodeQuotaForCustomerExceededFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The request cannot be processed because it would exceed the allowed number of cache nodes\n per customer. </p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheParameterGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p> The requested cache parameter group name does not refer to an existing cache parameter\n group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidVPCNetworkStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The VPC network is in an invalid state.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>CreateCacheCluster</i> operation creates a new cache cluster. All nodes in the\n cache cluster run the same protocol-compliant cache engine software - either Memcached\n or Redis.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n\t?Action=CreateCacheCluster\n\t&CacheClusterId=myMemcachedCluster\n\t&CacheNodeType=cache.m1.small\n\t&CacheSecurityGroupNames.member.1=default\n\t&Engine=memcached\n\t&NumCacheNodes=3\n\t&PreferredAvailabilityZones.member.1=us-east-1a\n\t&PreferredAvailabilityZones.member.2=us-east-1b\n\t&PreferredAvailabilityZones.member.3=us-east-1e\n\t&SignatureMethod=HmacSHA256&SignatureVersion=4\n\t&Version=2014-03-24\n\t&X-Amz-Algorithm=AWS4-HMAC-SHA256\n\t&X-Amz-Credential=[your-access-key-id]/20140721/us-east-1/elasticache/aws4_request\n\t&X-Amz-Date=20140724T170651Z\n\t&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date\n\t&X-Amz-Signature=[signature-value]</queryrequest>\n<!-- \n <queryresponse><![CDATA[\n<CreateCacheClusterResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <CreateCacheClusterResult>\n <CacheCluster>\n <CacheClusterStatus>creating</CacheClusterStatus>\n <NumCacheNodes>3</NumCacheNodes>\n <Engine>memcached</Engine>\n <PendingModifiedValues/>\n <EngineVersion>1.4.5</EngineVersion>\n <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>\n <PreferredMaintenanceWindow>sun:08:00-sun:09:00</PreferredMaintenanceWindow>\n <CacheNodeType>cache.m1.large</CacheNodeType>\n <CacheSecurityGroups>\n <CacheSecurityGroup>\n <CacheSecurityGroupName>default</CacheSecurityGroupName>\n <Status>active</Status>\n </CacheSecurityGroup>\n </CacheSecurityGroups>\n <CacheClusterId>mycache</CacheClusterId>\n </CacheCluster>\n </CreateCacheClusterResult>\n <ResponseMetadata>\n <RequestId>aaf2e796-363f-11e0-a564-8f11342c56b0</RequestId>\n </ResponseMetadata>\n</CreateCacheClusterResponse>]]></queryresponse>\n-->\n </examples>\n "
|
||||
},
|
||||
"CreateCacheParameterGroup": {
|
||||
"name": "CreateCacheParameterGroup",
|
||||
"input": {
|
||||
"shape_name": "CreateCacheParameterGroupMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A user-specified name for the cache parameter group.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"CacheParameterGroupFamily": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group family the cache parameter group can be used\n with.</p>\n <p>Valid values are: <code>memcached1.4</code> | <code>redis2.6</code> |\n <code>redis2.8</code></p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A user-specified description for the cache parameter group.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>CreateCacheParameterGroup</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CacheParameterGroupWrapper",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheParameterGroup": {
|
||||
"shape_name": "CacheParameterGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group.</p>\n "
|
||||
},
|
||||
"CacheParameterGroupFamily": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group family that this cache parameter group is\n compatible with.</p>\n "
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The description for this cache parameter group.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents the output of a <i>CreateCacheParameterGroup</i> operation.</p>\n "
|
||||
}
|
||||
}
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "CacheParameterGroupQuotaExceededFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The request cannot be processed because it would exceed the maximum number of cache\n security groups.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheParameterGroupAlreadyExistsFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>A cache parameter group with the requested name already exists.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidCacheParameterGroupStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The current state of the cache parameter group does not allow the requested action to\n occur. </p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>CreateCacheParameterGroup</i> operation creates a new cache parameter group. A\n cache parameter group is a collection of parameters that you apply to all of the nodes\n in a cache cluster.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=CreateCacheParameterGroup\n &Description=My%20first%20cache%20parameter%20group\n &CacheParameterGroupFamily=memcached1.4\n &CacheParameterGroupName=mycacheparametergroup1\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse>\n<CreateCacheParameterGroupResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <CreateCacheParameterGroupResult>\n <CacheParameterGroup>\n <CacheParameterGroupName>mycacheparametergroup3</CacheParameterGroupName>\n <CacheParameterGroupFamily>memcached1.4</CacheParameterGroupFamily>\n <Description>My first cache parameter group</Description>\n </CacheParameterGroup>\n </CreateCacheParameterGroupResult>\n <ResponseMetadata>\n <RequestId>05699541-b7f9-11e0-9326-b7275b9d4a6c</RequestId>\n </ResponseMetadata>\n</CreateCacheParameterGroupResponse></queryresponse>\n </examples>\n "
|
||||
},
|
||||
"CreateCacheSecurityGroup": {
|
||||
"name": "CreateCacheSecurityGroup",
|
||||
"input": {
|
||||
"shape_name": "CreateCacheSecurityGroupMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A name for the cache security group. This value is stored as a lowercase string.</p>\n <p>Constraints: Must contain no more than 255 alphanumeric characters. Must not be the word\n \"Default\".</p>\n <p>Example: <code>mysecuritygroup</code></p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A description for the cache security group.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>CreateCacheSecurityGroup</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CacheSecurityGroupWrapper",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSecurityGroup": {
|
||||
"shape_name": "CacheSecurityGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"OwnerId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The AWS account ID of the cache security group owner.</p>\n "
|
||||
},
|
||||
"CacheSecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache security group.</p>\n "
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The description of the cache security group.</p>\n "
|
||||
},
|
||||
"EC2SecurityGroups": {
|
||||
"shape_name": "EC2SecurityGroupList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "EC2SecurityGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the Amazon EC2 security group.</p>\n "
|
||||
},
|
||||
"EC2SecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Amazon EC2 security group.</p>\n "
|
||||
},
|
||||
"EC2SecurityGroupOwnerId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The AWS account ID of the Amazon EC2 security group owner.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Provides ownership and status information for an Amazon EC2 security group.</p>\n ",
|
||||
"xmlname": "EC2SecurityGroup"
|
||||
},
|
||||
"documentation": "\n <p>A list of Amazon EC2 security groups that are associated with this cache security\n group.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents the output of one of the following operations:</p>\n <ul>\n <li>\n <i>AuthorizeCacheSecurityGroupIngress</i>\n </li>\n <li>\n <i>CreateCacheSecurityGroup</i>\n </li>\n <li>\n <i>RevokeCacheSecurityGroupIngress</i>\n </li>\n </ul>\n "
|
||||
}
|
||||
}
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "CacheSecurityGroupAlreadyExistsFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>A cache security group with the specified name already exists.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheSecurityGroupQuotaExceededFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The request cannot be processed because it would exceed the allowed number of cache\n security groups.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>CreateCacheSecurityGroup</i> operation creates a new cache security group. Use a\n cache security group to control access to one or more cache clusters.</p>\n <p>Cache security groups are only used when you are creating a cluster outside of an Amazon\n Virtual Private Cloud (VPC). If you are creating a cluster inside of a VPC, use a cache\n subnet group instead. For more information, see <i>CreateCacheSubnetGroup</i>.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=CreateCacheSecurityGroup\n &CacheSecurityGroupName=mycachesecuritygroup\n &Description=My%20cache%20security%20group\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse><CreateCacheSecurityGroupResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <CreateCacheSecurityGroupResult>\n <CacheSecurityGroup>\n <EC2SecurityGroups/>\n <CacheSecurityGroupName>mycachesecuritygroup</CacheSecurityGroupName>\n <OwnerId>123456789012</OwnerId>\n <Description>My cache security group</Description>\n </CacheSecurityGroup>\n </CreateCacheSecurityGroupResult>\n <ResponseMetadata>\n <RequestId>2b1c8035-b7fa-11e0-9326-b7275b9d4a6c</RequestId>\n </ResponseMetadata>\n</CreateCacheSecurityGroupResponse></queryresponse>\n </examples>\n "
|
||||
},
|
||||
"CreateCacheSubnetGroup": {
|
||||
"name": "CreateCacheSubnetGroup",
|
||||
"input": {
|
||||
"shape_name": "CreateCacheSubnetGroupMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSubnetGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A name for the cache subnet group. This value is stored as a lowercase string.</p>\n <p>Constraints: Must contain no more than 255 alphanumeric characters or hyphens.</p>\n <p>Example: <code>mysubnetgroup</code></p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"CacheSubnetGroupDescription": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A description for the cache subnet group.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"SubnetIds": {
|
||||
"shape_name": "SubnetIdentifierList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "SubnetIdentifier"
|
||||
},
|
||||
"documentation": "\n <p>A list of VPC subnet IDs for the cache subnet group.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>CreateCacheSubnetGroup</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CacheSubnetGroupWrapper",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSubnetGroup": {
|
||||
"shape_name": "CacheSubnetGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSubnetGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache subnet group.</p>\n "
|
||||
},
|
||||
"CacheSubnetGroupDescription": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The description of the cache subnet group.</p>\n "
|
||||
},
|
||||
"VpcId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.</p>\n "
|
||||
},
|
||||
"Subnets": {
|
||||
"shape_name": "SubnetList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Subnet",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"SubnetIdentifier": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The unique identifier for the subnet</p>\n "
|
||||
},
|
||||
"SubnetAvailabilityZone": {
|
||||
"shape_name": "AvailabilityZone",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Availability Zone.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>The Availability Zone associated with the subnet</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the subnet associated with a cache cluster. This parameter refers to subnets\n defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.</p>\n ",
|
||||
"xmlname": "Subnet"
|
||||
},
|
||||
"documentation": "\n <p>A list of subnets associated with the cache subnet group.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents the output of one of the following operations:</p>\n <ul>\n <li>\n <i>CreateCacheSubnetGroup</i>\n </li>\n <li>\n <i>ModifyCacheSubnetGroup</i>\n </li>\n </ul>\n "
|
||||
}
|
||||
}
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "CacheSubnetGroupAlreadyExistsFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p> The requested cache subnet group name is already in use by an existing cache subnet\n group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheSubnetGroupQuotaExceededFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The request cannot be processed because it would exceed the allowed number of cache\n subnet groups.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheSubnetQuotaExceededFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The request cannot be processed because it would exceed the allowed number of subnets in\n a cache subnet group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidSubnet",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>An invalid subnet identifier was specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>CreateCacheSubnetGroup</i> operation creates a new cache subnet group.</p>\n <p>Use this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (VPC).</p>\n <examples>\n <queryrequest>https://elasticache.amazonaws.com/\n ?Action=CreateCacheSubnetGroup\n &CacheSubnetGroupName=myCachesubnetgroup\n &CacheSubnetGroupDescription=My%20new%20CacheSubnetGroup\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse><CreateCacheSubnetGroupResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <CreateCacheSubnetGroupResult>\n <CacheSubnetGroup>\n <VpcId>990524496922</VpcId>\n <CacheSubnetGroupDescription>My new CacheSubnetGroup</CacheSubnetGroupDescription>\n <CacheSubnetGroupName>myCachesubnetgroup</CacheSubnetGroupName>\n <Subnets>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-7c5b4115</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1c</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-7b5b4112</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1b</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-3ea6bd57</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1d</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n </Subnets>\n </CacheSubnetGroup>\n </CreateCacheSubnetGroupResult>\n <ResponseMetadata>\n <RequestId>ed662948-a57b-11df-9e38-7ffab86c801f</RequestId>\n </ResponseMetadata>\n </CreateCacheSubnetGroupResponse></queryresponse>\n </examples>\n "
|
||||
},
|
||||
"CreateReplicationGroup": {
|
||||
"name": "CreateReplicationGroup",
|
||||
"input": {
|
||||
"shape_name": "CreateReplicationGroupMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ReplicationGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The replication group identifier. This parameter is stored as a lowercase string.</p>\n \n<p>Constraints:</p>\n<ul>\n<li>Must contain from 1 to 20 alphanumeric characters or hyphens.</li>\n<li>First character must be a letter.</li>\n<li>Cannot end with a hyphen or contain two consecutive hyphens.</li>\n</ul>\n ",
|
||||
"required": true
|
||||
},
|
||||
"PrimaryClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier of the cache cluster that will serve as the primary for this replication\n group. This cache cluster must already exist and have a status of <i>available</i>.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"ReplicationGroupDescription": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A user-specified description for the replication group.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>CreateReplicationGroup</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ReplicationGroupWrapper",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ReplicationGroup": {
|
||||
"shape_name": "ReplicationGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ReplicationGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier for the replication group.</p>\n "
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The description of the replication group.</p>\n "
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of this replication group - <i>creating</i>, <i>available</i>, etc.</p>\n "
|
||||
},
|
||||
"PendingModifiedValues": {
|
||||
"shape_name": "ReplicationGroupPendingModifiedValues",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"PrimaryClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The primary cluster ID which will be applied immediately (if\n <code>--apply-immediately</code> was specified), or during the next maintenance\n window.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A group of settings to be applied to the replication group, either immediately or during\n the next maintenance window.</p>\n "
|
||||
},
|
||||
"MemberClusters": {
|
||||
"shape_name": "ClusterIdList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "ClusterId"
|
||||
},
|
||||
"documentation": "\n <p>The names of all the cache clusters that are part of this replication group.</p>\n "
|
||||
},
|
||||
"NodeGroups": {
|
||||
"shape_name": "NodeGroupList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "NodeGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"NodeGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier for the node group. A replication group contains only one node group;\n therefore, the node group ID is 0001.</p>\n "
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of this replication group - <i>creating</i>, <i>available</i>, etc.</p>\n "
|
||||
},
|
||||
"PrimaryEndpoint": {
|
||||
"shape_name": "Endpoint",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Address": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The DNS hostname of the cache node.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number that the cache engine is listening on.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the information required for client programs to connect to a cache node.</p>\n "
|
||||
},
|
||||
"NodeGroupMembers": {
|
||||
"shape_name": "NodeGroupMemberList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "NodeGroupMember",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of the cache cluster to which the node belongs.</p>\n "
|
||||
},
|
||||
"CacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of the node within its cache cluster. A node ID is a numeric identifier (0001,\n 0002, etc.).</p>\n "
|
||||
},
|
||||
"ReadEndpoint": {
|
||||
"shape_name": "Endpoint",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Address": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The DNS hostname of the cache node.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number that the cache engine is listening on.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the information required for client programs to connect to a cache node.</p>\n "
|
||||
},
|
||||
"PreferredAvailabilityZone": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Availability Zone in which the node is located.</p>\n "
|
||||
},
|
||||
"CurrentRole": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The role that is currently assigned to the node - <i>primary</i> or <i>replica</i>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents a single node within a node group.</p>\n ",
|
||||
"xmlname": "NodeGroupMember"
|
||||
},
|
||||
"documentation": "\n <p>A list containing information about individual nodes within the node group.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents a collection of cache nodes in a replication group.</p>\n ",
|
||||
"xmlname": "NodeGroup"
|
||||
},
|
||||
"documentation": "\n <p>A single element list with information about the nodes in the replication group.</p>\n "
|
||||
},
|
||||
"SnapshottingClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache cluster ID that is used as the daily snapshot source for the replication\n group.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Contains all of the attributes of a specific replication group.</p>\n "
|
||||
}
|
||||
}
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "CacheClusterNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache cluster ID does not refer to an existing cache cluster.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidCacheClusterStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache cluster is not in the <i>available</i> state.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "ReplicationGroupAlreadyExistsFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The specified replication group already exists.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>CreateReplicationGroup</i> operation creates a replication group. A replication\n group is a collection of cache clusters, where one of the clusters is a read/write\n primary and the other clusters are read-only replicas. Writes to the primary are\n automatically propagated to the replicas.</p>\n <p>When you create a replication group, you must specify an existing cache cluster that is\n in the primary role. When the replication group has been successfully created, you can\n add one or more read replica replicas to it, up to a total of five read replicas.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=CreateReplicationGroup ?ReplicationGroupDescription=My%20replication%20group\n &ReplicationGroupId=my-repgroup\n &PrimaryClusterId=my-redis-primary\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse><CreateReplicationGroupResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\"> \n <CreateReplicationGroupResult> \n <ReplicationGroup> \n <SnapshottingClusterId>my-redis-primary</SnapshottingClusterId> \n <MemberClusters> \n <ClusterId>my-redis-primary</ClusterId> \n </MemberClusters> \n <ReplicationGroupId>my-repgroup</ReplicationGroupId> \n <Status>creating</Status> \n <PendingModifiedValues /> \n <Description>My replication group</Description> \n </ReplicationGroup> \n </CreateReplicationGroupResult> \n <ResponseMetadata> \n <RequestId>f3b7b32d-b9d2-11e3-8a16-7978bb24ffdf</RequestId> \n </ResponseMetadata> \n</CreateReplicationGroupResponse></queryresponse>\n </examples>\n "
|
||||
},
|
||||
"CreateSnapshot": {
|
||||
"name": "CreateSnapshot",
|
||||
"input": {
|
||||
"shape_name": "CreateSnapshotMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier of an existing cache cluster. The snapshot will be created from this cache\n cluster.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"SnapshotName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A name for the snapshot being created.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>CreateSnapshotMessage</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "SnapshotWrapper",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Snapshot": {
|
||||
"shape_name": "Snapshot",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"SnapshotName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <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>\n "
|
||||
},
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The user-supplied identifier of the source cache cluster.</p>\n "
|
||||
},
|
||||
"SnapshotStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the snapshot. Valid values: <code>creating</code> | <code>available</code>\n | <code>restoring</code> | <code>copying</code> | <code>deleting</code>.</p>\n "
|
||||
},
|
||||
"SnapshotSource": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Indicates whether the snapshot is from an automatic backup (<code>automated</code>) or was created manually (<code>manual</code>).</p>\n "
|
||||
},
|
||||
"CacheNodeType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the compute and memory capacity node type for the source cache cluster.</p>\n "
|
||||
},
|
||||
"Engine": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache engine (<i>memcached</i> or <i>redis</i>) used by the source cache\n cluster.</p>\n "
|
||||
},
|
||||
"EngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The version of the cache engine version that is used by the source cache cluster.</p>\n "
|
||||
},
|
||||
"NumCacheNodes": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of cache nodes in the source cache cluster.</p>\n "
|
||||
},
|
||||
"PreferredAvailabilityZone": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Availability Zone in which the source cache cluster is located.</p>\n "
|
||||
},
|
||||
"CacheClusterCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the source cache cluster was created.</p>\n "
|
||||
},
|
||||
"PreferredMaintenanceWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p> The time range (in UTC) during which weekly system maintenance can occur on the source\n cache cluster.</p>\n "
|
||||
},
|
||||
"TopicArn": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon Resource Name (ARN) for the topic used by the source cache cluster for\n publishing notifications.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number used by each cache nodes in the source cache cluster.</p>\n "
|
||||
},
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache parameter group that is associated with the source cache cluster.</p>\n "
|
||||
},
|
||||
"CacheSubnetGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache subnet group associated with the source cache cluster.</p>\n "
|
||||
},
|
||||
"VpcId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the\n source cache cluster.</p>\n "
|
||||
},
|
||||
"AutoMinorVersionUpgrade": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>For the source cache cluster, indicates whether minor version patches are applied\n automatically (<code>true</code>) or not (<code>false</code>).</p>\n "
|
||||
},
|
||||
"SnapshotRetentionLimit": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.</p>\n <p>For manual snapshots, this field reflects the <i>SnapshotRetentionLimit</i> for the\n source cache cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the <i>DeleteSnapshot</i>\n action. </p>\n <p><b>Important</b><br>If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</p>\n "
|
||||
},
|
||||
"SnapshotWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The daily time range during which ElastiCache takes daily snapshots of the source cache\n cluster.</p>\n "
|
||||
},
|
||||
"NodeSnapshots": {
|
||||
"shape_name": "NodeSnapshotList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "NodeSnapshot",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache node identifier for the node in the source cache cluster.</p>\n "
|
||||
},
|
||||
"CacheSize": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The size of the cache on the source cache node.</p>\n "
|
||||
},
|
||||
"CacheNodeCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the cache node was created in the source cache cluster.</p>\n "
|
||||
},
|
||||
"SnapshotCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the source node's metadata and cache data set was obtained for the snapshot.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents an individual cache node in a snapshot of a cache cluster.</p>\n ",
|
||||
"xmlname": "NodeSnapshot"
|
||||
},
|
||||
"documentation": "\n <p>A list of the cache nodes in the source cache cluster.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents a copy of an entire cache cluster as of the time when the snapshot was taken.</p>\n "
|
||||
}
|
||||
}
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "SnapshotAlreadyExistsFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>You already have a snapshot with the given name.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheClusterNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache cluster ID does not refer to an existing cache cluster.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidCacheClusterStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache cluster is not in the <i>available</i> state.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "SnapshotQuotaExceededFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The request cannot be processed because it would exceed the maximum number of\n snapshots.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "SnapshotFeatureNotSupportedFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>You attempted one of the following actions:</p>\n <ul>\n <li>\n <p>Creating a snapshot of a Redis cache cluster running on a a <i>t1.micro</i> cache\n node.</p>\n </li>\n <li>\n <p>Creating a snapshot of a cache cluster that is running Memcached rather than\n Redis.</p>\n </li>\n </ul>\n <p>Neither of these are supported by ElastiCache.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>CreateSnapshot</i> operation creates a copy of an entire cache cluster at a\n specific moment in time.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=CreateSnapshot\n &CacheClusterId=my-redis-primary\n &SnapshotName=my-manual-snapshot\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse><CreateSnapshotResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\"> \n <CreateSnapshotResult> \n <Snapshot> \n <CacheClusterId>my-redis-primary</CacheClusterId> \n <Port>6379</Port> \n <CacheNodeType>cache.m1.small</CacheNodeType> \n <CacheParameterGroupName>default.redis2.8</CacheParameterGroupName> \n <Engine>redis</Engine> \n <PreferredAvailabilityZone>us-east-1d</PreferredAvailabilityZone> \n <CacheClusterCreateTime>2014-04-01T18:46:57.972Z</CacheClusterCreateTime> \n <EngineVersion>2.8.6</EngineVersion> \n <SnapshotSource>manual</SnapshotSource> \n <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade> \n <PreferredMaintenanceWindow>wed:09:00-wed:10:00</PreferredMaintenanceWindow> \n <SnapshotName>my-manual-snapshot</SnapshotName> \n <SnapshotRetentionLimit>5</SnapshotRetentionLimit> \n <NodeSnapshots> \n <NodeSnapshot> \n <CacheNodeCreateTime>2014-04-01T18:46:57.972Z</CacheNodeCreateTime> \n <CacheNodeId>0001</CacheNodeId> \n <CacheSize /> \n </NodeSnapshot> \n </NodeSnapshots> \n <SnapshotStatus>creating</SnapshotStatus> \n <NumCacheNodes>1</NumCacheNodes> \n <SnapshotWindow>07:30-08:30</SnapshotWindow> \n </Snapshot> \n </CreateSnapshotResult> \n <ResponseMetadata> \n <RequestId>faf5a232-b9ce-11e3-8a16-7978bb24ffdf</RequestId> \n </ResponseMetadata> \n</CreateSnapshotResponse>\n</queryresponse>\n </examples>\n "
|
||||
},
|
||||
"DeleteCacheCluster": {
|
||||
"name": "DeleteCacheCluster",
|
||||
"input": {
|
||||
"shape_name": "DeleteCacheClusterMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache cluster identifier for the cluster to be deleted. This parameter is not case\n sensitive.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"FinalSnapshotIdentifier": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of a final cache cluster snapshot. ElastiCache creates the snapshot, and then deletes\n the cache cluster immediately afterward.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>DeleteCacheCluster</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CacheClusterWrapper",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheCluster": {
|
||||
"shape_name": "CacheCluster",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The user-supplied identifier of the cache cluster. This is a unique key that identifies a\n cache cluster.</p>\n "
|
||||
},
|
||||
"ConfigurationEndpoint": {
|
||||
"shape_name": "Endpoint",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Address": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The DNS hostname of the cache node.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number that the cache engine is listening on.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the information required for client programs to connect to a cache node.</p>\n "
|
||||
},
|
||||
"ClientDownloadLandingPage": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The URL of the web page where you can download the latest ElastiCache client library.</p>\n "
|
||||
},
|
||||
"CacheNodeType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the compute and memory capacity node type for the cache cluster.</p>\n "
|
||||
},
|
||||
"Engine": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache engine (<i>memcached</i> or <i>redis</i>) to be used for this cache\n cluster.</p>\n "
|
||||
},
|
||||
"EngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The version of the cache engine version that is used in this cache cluster.</p>\n "
|
||||
},
|
||||
"CacheClusterStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of this cache cluster - <i>creating</i>, <i>available</i>, etc.</p>\n "
|
||||
},
|
||||
"NumCacheNodes": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of cache nodes in the cache cluster.</p>\n "
|
||||
},
|
||||
"PreferredAvailabilityZone": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Availability Zone in which the cache cluster is located or \n \"Multiple\" if the cache nodes are located in different Availability Zones.</p>\n "
|
||||
},
|
||||
"CacheClusterCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the cache cluster was created.</p>\n "
|
||||
},
|
||||
"PreferredMaintenanceWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The time range (in UTC) during which weekly system maintenance can occur.</p>\n "
|
||||
},
|
||||
"PendingModifiedValues": {
|
||||
"shape_name": "PendingModifiedValues",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"NumCacheNodes": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The new number of cache nodes for the cache cluster.</p>\n "
|
||||
},
|
||||
"CacheNodeIdsToRemove": {
|
||||
"shape_name": "CacheNodeIdsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "CacheNodeId"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache node IDs that are being removed (or will be removed) from the cache\n cluster. A node ID is a numeric identifier (0001, 0002, etc.).</p>\n "
|
||||
},
|
||||
"EngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The new cache engine version that the cache cluster will run.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A group of settings that will be applied to the cache cluster in the future, or that are\n currently being applied.</p>\n "
|
||||
},
|
||||
"NotificationConfiguration": {
|
||||
"shape_name": "NotificationConfiguration",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"TopicArn": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon Resource Name (ARN) that identifies the topic.</p>\n "
|
||||
},
|
||||
"TopicStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of the topic.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Describes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).</p>\n "
|
||||
},
|
||||
"CacheSecurityGroups": {
|
||||
"shape_name": "CacheSecurityGroupMembershipList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "CacheSecurityGroupMembership",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache security group.</p>\n "
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents a cache cluster's status within a particular cache security group.</p>\n ",
|
||||
"xmlname": "CacheSecurityGroup"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache security group elements, composed of name and status sub-elements.</p>\n "
|
||||
},
|
||||
"CacheParameterGroup": {
|
||||
"shape_name": "CacheParameterGroupStatus",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group.</p>\n "
|
||||
},
|
||||
"ParameterApplyStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of parameter updates.</p>\n "
|
||||
},
|
||||
"CacheNodeIdsToReboot": {
|
||||
"shape_name": "CacheNodeIdsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "CacheNodeId"
|
||||
},
|
||||
"documentation": "\n <p>A list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The status of the cache parameter group.</p>\n "
|
||||
},
|
||||
"CacheSubnetGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache subnet group associated with the cache cluster.</p>\n "
|
||||
},
|
||||
"CacheNodes": {
|
||||
"shape_name": "CacheNodeList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "CacheNode",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.</p>\n "
|
||||
},
|
||||
"CacheNodeStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of this cache node.</p>\n "
|
||||
},
|
||||
"CacheNodeCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the cache node was created.</p>\n "
|
||||
},
|
||||
"Endpoint": {
|
||||
"shape_name": "Endpoint",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Address": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The DNS hostname of the cache node.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number that the cache engine is listening on.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The hostname and IP address for connecting to this cache node.</p>\n "
|
||||
},
|
||||
"ParameterGroupStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the parameter group applied to this cache node.</p>\n "
|
||||
},
|
||||
"SourceCacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of the primary node to which this read replica node is synchronized. If this field\n is empty, then this node is not associated with a primary cache cluster.</p>\n "
|
||||
},
|
||||
"CustomerAvailabilityZone": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Availability Zone where this node was created and now resides.</p> \n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.</p>\n ",
|
||||
"xmlname": "CacheNode"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache nodes that are members of the cache cluster.</p>\n "
|
||||
},
|
||||
"AutoMinorVersionUpgrade": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>If <code>true</code>, then minor version patches are applied automatically; if\n <code>false</code>, then automatic minor version patches are disabled.</p>\n "
|
||||
},
|
||||
"SecurityGroups": {
|
||||
"shape_name": "SecurityGroupMembershipList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "SecurityGroupMembership",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"SecurityGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier of the cache security group.</p>\n "
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents a single cache security group and its status..</p>\n "
|
||||
},
|
||||
"documentation": "\n <p>A list of VPC Security Groups associated with the cache cluster.</p>\n "
|
||||
},
|
||||
"ReplicationGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.</p>\n "
|
||||
},
|
||||
"SnapshotRetentionLimit": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set <i>SnapshotRetentionLimit</i> to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.</p>\n <p><b>Important</b><br>If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</p>\n "
|
||||
},
|
||||
"SnapshotWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.</p>\n <p>Example: <code>05:00-09:00</code></p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Contains all of the attributes of a specific cache cluster.</p>\n "
|
||||
}
|
||||
}
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "CacheClusterNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache cluster ID does not refer to an existing cache cluster.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidCacheClusterStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache cluster is not in the <i>available</i> state.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "SnapshotAlreadyExistsFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>You already have a snapshot with the given name.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "SnapshotFeatureNotSupportedFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>You attempted one of the following actions:</p>\n <ul>\n <li>\n <p>Creating a snapshot of a Redis cache cluster running on a a <i>t1.micro</i> cache\n node.</p>\n </li>\n <li>\n <p>Creating a snapshot of a cache cluster that is running Memcached rather than\n Redis.</p>\n </li>\n </ul>\n <p>Neither of these are supported by ElastiCache.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "SnapshotQuotaExceededFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The request cannot be processed because it would exceed the maximum number of\n snapshots.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>DeleteCacheCluster</i> operation deletes a previously provisioned cache cluster.\n <i>DeleteCacheCluster</i> deletes all associated cache nodes, node endpoints and the\n cache cluster itself. When you receive a successful response from this operation,\n Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert\n this operation.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=DeleteCacheCluster\n &CacheClusterId=simcoprod43&Version=2014-03-24\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse>\n<DeleteCacheClusterResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <DeleteCacheClusterResult>\n <CacheCluster>\n <CacheParameterGroup>\n <ParameterApplyStatus>in-sync</ParameterApplyStatus>\n <CacheParameterGroupName>default.memcached1.4</CacheParameterGroupName>\n <CacheNodeIdsToReboot/>\n </CacheParameterGroup>\n <CacheClusterId>simcoprod43</CacheClusterId>\n <CacheClusterStatus>deleting</CacheClusterStatus>\n <ConfigurationEndpoint>\n <Port>11211</Port>\n <Address>simcoprod43.m2st2p.cfg.cache.amazonaws.com</Address>\n </ConfigurationEndpoint>\n <CacheNodeType>cache.m1.large</CacheNodeType>\n <Engine>memcached</Engine>\n <PendingModifiedValues/>\n <PreferredAvailabilityZone>us-east-1b</PreferredAvailabilityZone>\n <CacheClusterCreateTime>2014-03-27T02:18:26.497Z</CacheClusterCreateTime>\n <EngineVersion>1.4.5</EngineVersion>\n <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>\n <PreferredMaintenanceWindow>mon:05:00-mon:05:30</PreferredMaintenanceWindow>\n <CacheSecurityGroups>\n <CacheSecurityGroup>\n <CacheSecurityGroupName>default</CacheSecurityGroupName>\n <Status>active</Status>\n </CacheSecurityGroup>\n </CacheSecurityGroups>\n <NumCacheNodes>3</NumCacheNodes>\n </CacheCluster>\n </DeleteCacheClusterResult>\n <ResponseMetadata>\n <RequestId>ab84aa7e-b7fa-11e0-9b0b-a9261be2b354</RequestId>\n </ResponseMetadata>\n</DeleteCacheClusterResponse>\n </queryresponse>\n </examples>\n "
|
||||
},
|
||||
"DeleteCacheParameterGroup": {
|
||||
"name": "DeleteCacheParameterGroup",
|
||||
"input": {
|
||||
"shape_name": "DeleteCacheParameterGroupMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group to delete.</p>\n <note>The specified cache security group must not be associated with any cache clusters.</note>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>DeleteCacheParameterGroup</i> operation.</p>\n "
|
||||
},
|
||||
"output": null,
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidCacheParameterGroupStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The current state of the cache parameter group does not allow the requested action to\n occur. </p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheParameterGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p> The requested cache parameter group name does not refer to an existing cache parameter\n group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>DeleteCacheParameterGroup</i> operation deletes the specified cache parameter\n group. You cannot delete a cache parameter group if it is associated with any cache\n clusters.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=DeleteCacheParameterGroup\n &CacheParameterGroupName=myparametergroup\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse><DeleteCacheParameterGroupResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <ResponseMetadata>\n <RequestId>d0a417cb-575b-11e0-8869-cd22b4f9d96f</RequestId>\n </ResponseMetadata>\n</DeleteCacheParameterGroupResponse></queryresponse>\n </examples>\n "
|
||||
},
|
||||
"DeleteCacheSecurityGroup": {
|
||||
"name": "DeleteCacheSecurityGroup",
|
||||
"input": {
|
||||
"shape_name": "DeleteCacheSecurityGroupMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache security group to delete.</p>\n <note>You cannot delete the default security group.</note>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>DeleteCacheSecurityGroup</i> operation.</p>\n "
|
||||
},
|
||||
"output": null,
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidCacheSecurityGroupStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The current state of the cache security group does not allow deletion.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheSecurityGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p> The requested cache security group name does not refer to an existing cache security\n group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>DeleteCacheSecurityGroup</i> operation deletes a cache security group.</p>\n <note>You cannot delete a cache security group if it is associated with any cache clusters.</note>\n <examples>\n <queryrequest>\n https://elasticache.us-east-1.amazonaws.com/\n ?Action=DeleteCacheSecurityGroup\n &CacheSecurityGroupName=mycachesecuritygroup3\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse>\n<DeleteCacheSecurityGroupResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <ResponseMetadata>\n <RequestId>c130cfb7-3650-11e0-ae57-f96cfe56749c</RequestId>\n </ResponseMetadata>\n</DeleteCacheSecurityGroupResponse></queryresponse>\n </examples>\n "
|
||||
},
|
||||
"DeleteCacheSubnetGroup": {
|
||||
"name": "DeleteCacheSubnetGroup",
|
||||
"input": {
|
||||
"shape_name": "DeleteCacheSubnetGroupMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSubnetGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache subnet group to delete.</p>\n <p>Constraints: Must contain no more than 255 alphanumeric characters or hyphens.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>DeleteCacheSubnetGroup</i> operation.</p>\n "
|
||||
},
|
||||
"output": null,
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "CacheSubnetGroupInUse",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache subnet group is currently in use.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheSubnetGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache subnet group name does not refer to an existing cache subnet\n group.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>DeleteCacheSubnetGroup</i> operation deletes a cache subnet group.</p>\n <note>You cannot delete a cache subnet group if it is associated with any cache\n clusters.</note>\n <examples>\n <queryrequest>https://elasticache.amazonaws.com/\n ?Action=DeleteCacheSubnetGroup\n &CacheSubnetGroupName=mysubnetgroup\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse><DeleteCacheSubnetGroupResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <ResponseMetadata>\n <RequestId>5d013245-4172-11df-8520-e7e1e602a915</RequestId>\n </ResponseMetadata>\n </DeleteCacheSubnetGroupResponse></queryresponse>\n </examples>\n "
|
||||
},
|
||||
"DeleteReplicationGroup": {
|
||||
"name": "DeleteReplicationGroup",
|
||||
"input": {
|
||||
"shape_name": "DeleteReplicationGroupMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ReplicationGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier for the replication group to be deleted. This parameter is not case\n sensitive.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"RetainPrimaryCluster": {
|
||||
"shape_name": "BooleanOptional",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>If set to <i>true</i>, all of the read replicas will be deleted, but the primary cache\n cluster will be retained.</p>\n "
|
||||
},
|
||||
"FinalSnapshotIdentifier": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of a final cache cluster snapshot. ElastiCache creates the snapshot from the primary cluster in the replication group, 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 deleted immediately afterward.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>DeleteReplicationGroup</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ReplicationGroupWrapper",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ReplicationGroup": {
|
||||
"shape_name": "ReplicationGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ReplicationGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier for the replication group.</p>\n "
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The description of the replication group.</p>\n "
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of this replication group - <i>creating</i>, <i>available</i>, etc.</p>\n "
|
||||
},
|
||||
"PendingModifiedValues": {
|
||||
"shape_name": "ReplicationGroupPendingModifiedValues",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"PrimaryClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The primary cluster ID which will be applied immediately (if\n <code>--apply-immediately</code> was specified), or during the next maintenance\n window.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A group of settings to be applied to the replication group, either immediately or during\n the next maintenance window.</p>\n "
|
||||
},
|
||||
"MemberClusters": {
|
||||
"shape_name": "ClusterIdList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "ClusterId"
|
||||
},
|
||||
"documentation": "\n <p>The names of all the cache clusters that are part of this replication group.</p>\n "
|
||||
},
|
||||
"NodeGroups": {
|
||||
"shape_name": "NodeGroupList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "NodeGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"NodeGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier for the node group. A replication group contains only one node group;\n therefore, the node group ID is 0001.</p>\n "
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of this replication group - <i>creating</i>, <i>available</i>, etc.</p>\n "
|
||||
},
|
||||
"PrimaryEndpoint": {
|
||||
"shape_name": "Endpoint",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Address": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The DNS hostname of the cache node.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number that the cache engine is listening on.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the information required for client programs to connect to a cache node.</p>\n "
|
||||
},
|
||||
"NodeGroupMembers": {
|
||||
"shape_name": "NodeGroupMemberList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "NodeGroupMember",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of the cache cluster to which the node belongs.</p>\n "
|
||||
},
|
||||
"CacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of the node within its cache cluster. A node ID is a numeric identifier (0001,\n 0002, etc.).</p>\n "
|
||||
},
|
||||
"ReadEndpoint": {
|
||||
"shape_name": "Endpoint",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Address": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The DNS hostname of the cache node.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number that the cache engine is listening on.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the information required for client programs to connect to a cache node.</p>\n "
|
||||
},
|
||||
"PreferredAvailabilityZone": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Availability Zone in which the node is located.</p>\n "
|
||||
},
|
||||
"CurrentRole": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The role that is currently assigned to the node - <i>primary</i> or <i>replica</i>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents a single node within a node group.</p>\n ",
|
||||
"xmlname": "NodeGroupMember"
|
||||
},
|
||||
"documentation": "\n <p>A list containing information about individual nodes within the node group.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents a collection of cache nodes in a replication group.</p>\n ",
|
||||
"xmlname": "NodeGroup"
|
||||
},
|
||||
"documentation": "\n <p>A single element list with information about the nodes in the replication group.</p>\n "
|
||||
},
|
||||
"SnapshottingClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache cluster ID that is used as the daily snapshot source for the replication\n group.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Contains all of the attributes of a specific replication group.</p>\n "
|
||||
}
|
||||
}
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "ReplicationGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The specified replication group does not exist.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidReplicationGroupStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested replication group is not in the <i>available</i> state.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "SnapshotAlreadyExistsFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>You already have a snapshot with the given name.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "SnapshotFeatureNotSupportedFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>You attempted one of the following actions:</p>\n <ul>\n <li>\n <p>Creating a snapshot of a Redis cache cluster running on a a <i>t1.micro</i> cache\n node.</p>\n </li>\n <li>\n <p>Creating a snapshot of a cache cluster that is running Memcached rather than\n Redis.</p>\n </li>\n </ul>\n <p>Neither of these are supported by ElastiCache.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "SnapshotQuotaExceededFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The request cannot be processed because it would exceed the maximum number of\n snapshots.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>DeleteReplicationGroup</i> operation deletes an existing replication group. By\n default, this operation deletes the entire replication group, including the primary\n cache cluster and all of the read replicas. You can optionally delete only the read\n replicas, while retaining the primary cache cluster.</p>\n <p>When you receive a successful response from this operation, Amazon ElastiCache immediately begins\n deleting the selected resources; you cannot cancel or revert this operation.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=DeleteReplicationGroup &RetainPrimaryCluster=false\n &FinalSnapshotIdentifier=my-final-snapshot\n &ReplicationGroupId=my-repgroup\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse><DeleteReplicationGroupResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\"> \n <DeleteReplicationGroupResult> \n <ReplicationGroup> \n <SnapshottingClusterId>my-redis-primary</SnapshottingClusterId> \n <ReplicationGroupId>my-repgroup</ReplicationGroupId> \n <Status>deleting</Status> \n <PendingModifiedValues /> \n <Description>My replication group</Description> \n </ReplicationGroup> \n </DeleteReplicationGroupResult> \n <ResponseMetadata> \n <RequestId>93eb37db-b9d7-11e3-8a16-7978bb24ffdf</RequestId> \n </ResponseMetadata> \n</DeleteReplicationGroupResponse></queryresponse>\n </examples>\n "
|
||||
},
|
||||
"DeleteSnapshot": {
|
||||
"name": "DeleteSnapshot",
|
||||
"input": {
|
||||
"shape_name": "DeleteSnapshotMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"SnapshotName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the snapshot to be deleted.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>DeleteSnapshotMessage</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "SnapshotWrapper",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Snapshot": {
|
||||
"shape_name": "Snapshot",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"SnapshotName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <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>\n "
|
||||
},
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The user-supplied identifier of the source cache cluster.</p>\n "
|
||||
},
|
||||
"SnapshotStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the snapshot. Valid values: <code>creating</code> | <code>available</code>\n | <code>restoring</code> | <code>copying</code> | <code>deleting</code>.</p>\n "
|
||||
},
|
||||
"SnapshotSource": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Indicates whether the snapshot is from an automatic backup (<code>automated</code>) or was created manually (<code>manual</code>).</p>\n "
|
||||
},
|
||||
"CacheNodeType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the compute and memory capacity node type for the source cache cluster.</p>\n "
|
||||
},
|
||||
"Engine": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache engine (<i>memcached</i> or <i>redis</i>) used by the source cache\n cluster.</p>\n "
|
||||
},
|
||||
"EngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The version of the cache engine version that is used by the source cache cluster.</p>\n "
|
||||
},
|
||||
"NumCacheNodes": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of cache nodes in the source cache cluster.</p>\n "
|
||||
},
|
||||
"PreferredAvailabilityZone": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Availability Zone in which the source cache cluster is located.</p>\n "
|
||||
},
|
||||
"CacheClusterCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the source cache cluster was created.</p>\n "
|
||||
},
|
||||
"PreferredMaintenanceWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p> The time range (in UTC) during which weekly system maintenance can occur on the source\n cache cluster.</p>\n "
|
||||
},
|
||||
"TopicArn": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon Resource Name (ARN) for the topic used by the source cache cluster for\n publishing notifications.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number used by each cache nodes in the source cache cluster.</p>\n "
|
||||
},
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache parameter group that is associated with the source cache cluster.</p>\n "
|
||||
},
|
||||
"CacheSubnetGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache subnet group associated with the source cache cluster.</p>\n "
|
||||
},
|
||||
"VpcId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the\n source cache cluster.</p>\n "
|
||||
},
|
||||
"AutoMinorVersionUpgrade": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>For the source cache cluster, indicates whether minor version patches are applied\n automatically (<code>true</code>) or not (<code>false</code>).</p>\n "
|
||||
},
|
||||
"SnapshotRetentionLimit": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.</p>\n <p>For manual snapshots, this field reflects the <i>SnapshotRetentionLimit</i> for the\n source cache cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the <i>DeleteSnapshot</i>\n action. </p>\n <p><b>Important</b><br>If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</p>\n "
|
||||
},
|
||||
"SnapshotWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The daily time range during which ElastiCache takes daily snapshots of the source cache\n cluster.</p>\n "
|
||||
},
|
||||
"NodeSnapshots": {
|
||||
"shape_name": "NodeSnapshotList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "NodeSnapshot",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache node identifier for the node in the source cache cluster.</p>\n "
|
||||
},
|
||||
"CacheSize": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The size of the cache on the source cache node.</p>\n "
|
||||
},
|
||||
"CacheNodeCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the cache node was created in the source cache cluster.</p>\n "
|
||||
},
|
||||
"SnapshotCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the source node's metadata and cache data set was obtained for the snapshot.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents an individual cache node in a snapshot of a cache cluster.</p>\n ",
|
||||
"xmlname": "NodeSnapshot"
|
||||
},
|
||||
"documentation": "\n <p>A list of the cache nodes in the source cache cluster.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents a copy of an entire cache cluster as of the time when the snapshot was taken.</p>\n "
|
||||
}
|
||||
}
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "SnapshotNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested snapshot name does not refer to an existing snapshot.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidSnapshotStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The current state of the snapshot does not allow the requested action to occur.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>DeleteSnapshot</i> operation deletes an existing snapshot. When you receive a\n successful response from this operation, ElastiCache immediately begins deleting the snapshot;\n you cannot cancel or revert this operation.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=DeleteSnapshot\n &SnapshotName=my-manual-snapshot\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse><DeleteSnapshotResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\"> \n <DeleteSnapshotResult> \n <Snapshot> \n <CacheClusterId>my-redis-primary</CacheClusterId> \n <Port>6379</Port> \n <CacheNodeType>cache.m1.small</CacheNodeType> \n <CacheParameterGroupName>default.redis2.8</CacheParameterGroupName> \n <Engine>redis</Engine> \n <PreferredAvailabilityZone>us-east-1d</PreferredAvailabilityZone> \n <CacheClusterCreateTime>2014-04-01T18:46:57.972Z</CacheClusterCreateTime> \n <EngineVersion>2.8.6</EngineVersion> \n <SnapshotSource>manual</SnapshotSource> \n <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade> \n <PreferredMaintenanceWindow>wed:09:00-wed:10:00</PreferredMaintenanceWindow> \n <SnapshotName>my-manual-snapshot</SnapshotName> \n <SnapshotRetentionLimit>5</SnapshotRetentionLimit> \n <NodeSnapshots> \n <NodeSnapshot> \n <SnapshotCreateTime>2014-04-01T18:54:12Z</SnapshotCreateTime> \n <CacheNodeCreateTime>2014-04-01T18:46:57.972Z</CacheNodeCreateTime> \n <CacheNodeId>0001</CacheNodeId> \n <CacheSize>3 MB</CacheSize> \n </NodeSnapshot> \n </NodeSnapshots> \n <SnapshotStatus>deleting</SnapshotStatus> \n <NumCacheNodes>1</NumCacheNodes> \n <SnapshotWindow>07:30-08:30</SnapshotWindow> \n </Snapshot> \n </DeleteSnapshotResult> \n <ResponseMetadata> \n <RequestId>694d7017-b9d2-11e3-8a16-7978bb24ffdf</RequestId> \n </ResponseMetadata> \n</DeleteSnapshotResponse>\n</queryresponse>\n </examples>\n "
|
||||
},
|
||||
"DescribeCacheClusters": {
|
||||
"name": "DescribeCacheClusters",
|
||||
"input": {
|
||||
"shape_name": "DescribeCacheClustersMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The user-supplied cluster identifier. If this parameter is specified, only information\n about that specific cache cluster is returned. This parameter isn't case sensitive.</p>\n "
|
||||
},
|
||||
"MaxRecords": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n \n <p>The maximum number of records to include in the response. If more records exist than the\n specified <code>MaxRecords</code> value, a marker is included in the response so that\n the remaining results can be retrieved.</p>\n\n <p>Default: 100</p>\n<p>Constraints: minimum 20; maximum 100.</p>"
|
||||
},
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by <i>MaxRecords</i>.</p>\n "
|
||||
},
|
||||
"ShowCacheNodeInfo": {
|
||||
"shape_name": "BooleanOptional",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>An optional flag that can be included in the DescribeCacheCluster request to retrieve\n information about the individual cache nodes.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>DescribeCacheClusters</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CacheClusterMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>Provides an identifier to allow retrieval of paginated results.</p>\n "
|
||||
},
|
||||
"CacheClusters": {
|
||||
"shape_name": "CacheClusterList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "CacheCluster",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The user-supplied identifier of the cache cluster. This is a unique key that identifies a\n cache cluster.</p>\n "
|
||||
},
|
||||
"ConfigurationEndpoint": {
|
||||
"shape_name": "Endpoint",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Address": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The DNS hostname of the cache node.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number that the cache engine is listening on.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the information required for client programs to connect to a cache node.</p>\n "
|
||||
},
|
||||
"ClientDownloadLandingPage": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The URL of the web page where you can download the latest ElastiCache client library.</p>\n "
|
||||
},
|
||||
"CacheNodeType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the compute and memory capacity node type for the cache cluster.</p>\n "
|
||||
},
|
||||
"Engine": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache engine (<i>memcached</i> or <i>redis</i>) to be used for this cache\n cluster.</p>\n "
|
||||
},
|
||||
"EngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The version of the cache engine version that is used in this cache cluster.</p>\n "
|
||||
},
|
||||
"CacheClusterStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of this cache cluster - <i>creating</i>, <i>available</i>, etc.</p>\n "
|
||||
},
|
||||
"NumCacheNodes": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of cache nodes in the cache cluster.</p>\n "
|
||||
},
|
||||
"PreferredAvailabilityZone": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Availability Zone in which the cache cluster is located or \n \"Multiple\" if the cache nodes are located in different Availability Zones.</p>\n "
|
||||
},
|
||||
"CacheClusterCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the cache cluster was created.</p>\n "
|
||||
},
|
||||
"PreferredMaintenanceWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The time range (in UTC) during which weekly system maintenance can occur.</p>\n "
|
||||
},
|
||||
"PendingModifiedValues": {
|
||||
"shape_name": "PendingModifiedValues",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"NumCacheNodes": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The new number of cache nodes for the cache cluster.</p>\n "
|
||||
},
|
||||
"CacheNodeIdsToRemove": {
|
||||
"shape_name": "CacheNodeIdsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "CacheNodeId"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache node IDs that are being removed (or will be removed) from the cache\n cluster. A node ID is a numeric identifier (0001, 0002, etc.).</p>\n "
|
||||
},
|
||||
"EngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The new cache engine version that the cache cluster will run.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A group of settings that will be applied to the cache cluster in the future, or that are\n currently being applied.</p>\n "
|
||||
},
|
||||
"NotificationConfiguration": {
|
||||
"shape_name": "NotificationConfiguration",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"TopicArn": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon Resource Name (ARN) that identifies the topic.</p>\n "
|
||||
},
|
||||
"TopicStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of the topic.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Describes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).</p>\n "
|
||||
},
|
||||
"CacheSecurityGroups": {
|
||||
"shape_name": "CacheSecurityGroupMembershipList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "CacheSecurityGroupMembership",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache security group.</p>\n "
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents a cache cluster's status within a particular cache security group.</p>\n ",
|
||||
"xmlname": "CacheSecurityGroup"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache security group elements, composed of name and status sub-elements.</p>\n "
|
||||
},
|
||||
"CacheParameterGroup": {
|
||||
"shape_name": "CacheParameterGroupStatus",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group.</p>\n "
|
||||
},
|
||||
"ParameterApplyStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of parameter updates.</p>\n "
|
||||
},
|
||||
"CacheNodeIdsToReboot": {
|
||||
"shape_name": "CacheNodeIdsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "CacheNodeId"
|
||||
},
|
||||
"documentation": "\n <p>A list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The status of the cache parameter group.</p>\n "
|
||||
},
|
||||
"CacheSubnetGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache subnet group associated with the cache cluster.</p>\n "
|
||||
},
|
||||
"CacheNodes": {
|
||||
"shape_name": "CacheNodeList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "CacheNode",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.</p>\n "
|
||||
},
|
||||
"CacheNodeStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of this cache node.</p>\n "
|
||||
},
|
||||
"CacheNodeCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the cache node was created.</p>\n "
|
||||
},
|
||||
"Endpoint": {
|
||||
"shape_name": "Endpoint",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Address": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The DNS hostname of the cache node.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number that the cache engine is listening on.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The hostname and IP address for connecting to this cache node.</p>\n "
|
||||
},
|
||||
"ParameterGroupStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the parameter group applied to this cache node.</p>\n "
|
||||
},
|
||||
"SourceCacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of the primary node to which this read replica node is synchronized. If this field\n is empty, then this node is not associated with a primary cache cluster.</p>\n "
|
||||
},
|
||||
"CustomerAvailabilityZone": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Availability Zone where this node was created and now resides.</p> \n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.</p>\n ",
|
||||
"xmlname": "CacheNode"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache nodes that are members of the cache cluster.</p>\n "
|
||||
},
|
||||
"AutoMinorVersionUpgrade": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>If <code>true</code>, then minor version patches are applied automatically; if\n <code>false</code>, then automatic minor version patches are disabled.</p>\n "
|
||||
},
|
||||
"SecurityGroups": {
|
||||
"shape_name": "SecurityGroupMembershipList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "SecurityGroupMembership",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"SecurityGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier of the cache security group.</p>\n "
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents a single cache security group and its status..</p>\n "
|
||||
},
|
||||
"documentation": "\n <p>A list of VPC Security Groups associated with the cache cluster.</p>\n "
|
||||
},
|
||||
"ReplicationGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.</p>\n "
|
||||
},
|
||||
"SnapshotRetentionLimit": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set <i>SnapshotRetentionLimit</i> to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.</p>\n <p><b>Important</b><br>If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</p>\n "
|
||||
},
|
||||
"SnapshotWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.</p>\n <p>Example: <code>05:00-09:00</code></p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Contains all of the attributes of a specific cache cluster.</p>\n ",
|
||||
"xmlname": "CacheCluster"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache clusters. Each item in the list contains detailed information about one\n cache cluster.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the output of a <i>DescribeCacheClusters</i> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "CacheClusterNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache cluster ID does not refer to an existing cache cluster.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>DescribeCacheClusters</i> operation returns information about all provisioned\n cache clusters if no cache cluster identifier is specified, or about a specific cache\n cluster if a cache cluster identifier is supplied.</p>\n <p>By default, abbreviated information about the cache clusters(s) will be returned. You can\n use the optional <i>ShowDetails</i> flag to retrieve detailed information about the\n cache nodes associated with the cache clusters. These details include the DNS address\n and port for the cache node endpoint.</p>\n <p>If the cluster is in the CREATING state, only cluster level information will be displayed\n until all of the nodes are successfully provisioned.</p>\n <p>If the cluster is in the DELETING state, only cluster level information will be\n displayed.</p>\n <p>If cache nodes are currently being added to the cache cluster, node endpoint information\n and creation time for the additional nodes will not be displayed until they are\n completely provisioned. When the cache cluster state is <i>available</i>, the cluster is\n ready for use.</p>\n <p>If cache nodes are currently being removed from the cache cluster, no endpoint\n information for the removed nodes is displayed.</p>\n\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=DescribeCacheClusters\n &MaxRecords=100\n &ShowCacheNodeInfo=false\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse>\n<DescribeCacheClustersResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <DescribeCacheClustersResult>\n <CacheClusters>\n <CacheCluster>\n <CacheParameterGroup>\n <ParameterApplyStatus>in-sync</ParameterApplyStatus>\n <CacheParameterGroupName>default.memcached1.4</CacheParameterGroupName>\n <CacheNodeIdsToReboot/>\n </CacheParameterGroup>\n <CacheClusterId>simcoprod42</CacheClusterId>\n <CacheClusterStatus>available</CacheClusterStatus>\n <ConfigurationEndpoint>\n <Port>11211</Port>\n <Address>simcoprod42.m2st2p.cfg.cache.amazonaws.com</Address>\n </ConfigurationEndpoint>\n <ClientDownloadLandingPage>\n https://console.aws.amazon.com/elasticache/home#client-download:\n </ClientDownloadLandingPage>\n <CacheNodeType>cache.m1.large</CacheNodeType>\n <Engine>memcached</Engine>\n <PendingModifiedValues/>\n <PreferredAvailabilityZone>us-east-1d</PreferredAvailabilityZone>\n <CacheClusterCreateTime>2014-03-26T01:21:46.607Z</CacheClusterCreateTime>\n <EngineVersion>1.4.5</EngineVersion>\n <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>\n <PreferredMaintenanceWindow>fri:08:30-fri:09:00</PreferredMaintenanceWindow>\n <CacheSecurityGroups>\n <CacheSecurityGroup>\n <CacheSecurityGroupName>default</CacheSecurityGroupName>\n <Status>active</Status>\n </CacheSecurityGroup>\n </CacheSecurityGroups>\n <NotificationConfiguration>\n <TopicStatus>active</TopicStatus>\n <TopicArn>arn:aws:sns:us-east-1:123456789012:ElastiCacheNotifications</TopicArn>\n </NotificationConfiguration>\n <NumCacheNodes>6</NumCacheNodes>\n </CacheCluster>\n </CacheClusters>\n </DescribeCacheClustersResult>\n <ResponseMetadata>\n <RequestId>f270d58f-b7fb-11e0-9326-b7275b9d4a6c</RequestId>\n </ResponseMetadata>\n</DescribeCacheClustersResponse></queryresponse>\n </examples>\n ",
|
||||
"pagination": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "CacheClusters",
|
||||
"py_input_token": "marker"
|
||||
}
|
||||
},
|
||||
"DescribeCacheEngineVersions": {
|
||||
"name": "DescribeCacheEngineVersions",
|
||||
"input": {
|
||||
"shape_name": "DescribeCacheEngineVersionsMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Engine": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache engine to return. Valid values: <code>memcached</code> | <code>redis</code></p>\n "
|
||||
},
|
||||
"EngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache engine version to return.</p>\n <p>Example: <code>1.4.14</code></p>\n "
|
||||
},
|
||||
"CacheParameterGroupFamily": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of a specific cache parameter group family to return details for.</p>\n <p>Constraints:</p>\n <ul>\n <li>Must be 1 to 255 alphanumeric characters</li>\n <li>First character must be a letter</li>\n <li>Cannot end with a hyphen or contain two consecutive hyphens</li>\n </ul>\n "
|
||||
},
|
||||
"MaxRecords": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": " \n \n <p>The maximum number of records to include in the response. If more records exist than the\n specified <code>MaxRecords</code> value, a marker is included in the response so that\n the remaining results can be retrieved.</p>\n \n <p>Default: 100</p>\n<p>Constraints: minimum 20; maximum 100.</p>\n "
|
||||
},
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by <i>MaxRecords</i>.</p>\n "
|
||||
},
|
||||
"DefaultOnly": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>If <i>true</i>, specifies that only the default version of the specified engine or engine\n and major version combination is to be returned.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>DescribeCacheEngineVersions</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CacheEngineVersionMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>Provides an identifier to allow retrieval of paginated results.</p>\n "
|
||||
},
|
||||
"CacheEngineVersions": {
|
||||
"shape_name": "CacheEngineVersionList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "CacheEngineVersion",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Engine": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache engine.</p>\n "
|
||||
},
|
||||
"EngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The version number of the cache engine.</p>\n "
|
||||
},
|
||||
"CacheParameterGroupFamily": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group family associated with this cache engine.</p>\n "
|
||||
},
|
||||
"CacheEngineDescription": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The description of the cache engine.</p>\n "
|
||||
},
|
||||
"CacheEngineVersionDescription": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The description of the cache engine version.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Provides all of the details about a particular cache engine version.</p>\n ",
|
||||
"xmlname": "CacheEngineVersion"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache engine version details. Each element in the list contains detailed\n information about once cache engine version.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the output of a <a>DescribeCacheEngineVersions</a> operation.</p>\n "
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "\n <p>The <i>DescribeCacheEngineVersions</i> operation returns a list of the available cache\n engines and their versions.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=DescribeCacheEngineVersions\n &MaxRecords=100\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse>\n<DescribeCacheEngineVersionsResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <DescribeCacheEngineVersionsResult>\n <CacheEngineVersions>\n <CacheEngineVersion>\n <CacheParameterGroupFamily>memcached1.4</CacheParameterGroupFamily>\n <Engine>memcached</Engine>\n <CacheEngineVersionDescription>memcached version 1.4.14</CacheEngineVersionDescription>\n <CacheEngineDescription>memcached</CacheEngineDescription>\n <EngineVersion>1.4.14</EngineVersion>\n </CacheEngineVersion>\n <CacheEngineVersion>\n <CacheParameterGroupFamily>memcached1.4</CacheParameterGroupFamily>\n <Engine>memcached</Engine>\n <CacheEngineVersionDescription>memcached version 1.4.5</CacheEngineVersionDescription>\n <CacheEngineDescription>memcached</CacheEngineDescription>\n <EngineVersion>1.4.5</EngineVersion>\n </CacheEngineVersion>\n </CacheEngineVersions>\n </DescribeCacheEngineVersionsResult>\n <ResponseMetadata>\n <RequestId>a6ac9ad2-f8a4-11e1-a4d1-a345e5370093</RequestId>\n </ResponseMetadata>\n</DescribeCacheEngineVersionsResponse>\n</queryresponse>\n </examples>\n ",
|
||||
"pagination": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "CacheEngineVersions",
|
||||
"py_input_token": "marker"
|
||||
}
|
||||
},
|
||||
"DescribeCacheParameterGroups": {
|
||||
"name": "DescribeCacheParameterGroups",
|
||||
"input": {
|
||||
"shape_name": "DescribeCacheParameterGroupsMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of a specific cache parameter group to return details for.</p>\n "
|
||||
},
|
||||
"MaxRecords": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n \n <p>The maximum number of records to include in the response. If more records exist than the\n specified <code>MaxRecords</code> value, a marker is included in the response so that\n the remaining results can be retrieved.</p>\n \n <p>Default: 100</p>\n<p>Constraints: minimum 20; maximum 100.</p>\n "
|
||||
},
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by <i>MaxRecords</i>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>DescribeCacheParameterGroups</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CacheParameterGroupsMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>Provides an identifier to allow retrieval of paginated results.</p>\n "
|
||||
},
|
||||
"CacheParameterGroups": {
|
||||
"shape_name": "CacheParameterGroupList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "CacheParameterGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group.</p>\n "
|
||||
},
|
||||
"CacheParameterGroupFamily": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group family that this cache parameter group is\n compatible with.</p>\n "
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The description for this cache parameter group.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents the output of a <i>CreateCacheParameterGroup</i> operation.</p>\n ",
|
||||
"xmlname": "CacheParameterGroup"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache parameter groups. Each element in the list contains detailed information\n about one cache parameter group.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the output of a <i>DescribeCacheParameterGroups</i> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "CacheParameterGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p> The requested cache parameter group name does not refer to an existing cache parameter\n group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>DescribeCacheParameterGroups</i> operation returns a list of cache parameter group\n descriptions. If a cache parameter group name is specified, the list will contain only\n the descriptions for that group.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=DescribeCacheParameterGroups\n &MaxRecords=100\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse>\n<DescribeCacheParameterGroupsResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <DescribeCacheParameterGroupsResult>\n <CacheParameterGroups>\n <CacheParameterGroup>\n <CacheParameterGroupName>default.memcached1.4</CacheParameterGroupName>\n <CacheParameterGroupFamily>memcached1.4</CacheParameterGroupFamily>\n <Description>Default parameter group for memcached1.4</Description>\n </CacheParameterGroup>\n <CacheParameterGroup>\n <CacheParameterGroupName>mycacheparametergroup</CacheParameterGroupName>\n <CacheParameterGroupFamily>memcached1.4</CacheParameterGroupFamily>\n <Description>My cache parameter group</Description>\n </CacheParameterGroup>\n <CacheParameterGroup>\n <CacheParameterGroupName>mycacheparametergroup1</CacheParameterGroupName>\n <CacheParameterGroupFamily>memcached1.4</CacheParameterGroupFamily>\n <Description>My first cache parameter group</Description>\n </CacheParameterGroup>\n <CacheParameterGroup>\n <CacheParameterGroupName>mycacheparametergroup3</CacheParameterGroupName>\n <CacheParameterGroupFamily>memcached1.4</CacheParameterGroupFamily>\n <Description>My first cache parameter group</Description>\n </CacheParameterGroup>\n </CacheParameterGroups>\n </DescribeCacheParameterGroupsResult>\n <ResponseMetadata>\n <RequestId>7193fbb8-b7fc-11e0-9b0b-a9261be2b354</RequestId>\n </ResponseMetadata>\n</DescribeCacheParameterGroupsResponse>\n</queryresponse>\n </examples>\n ",
|
||||
"pagination": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "CacheParameterGroups",
|
||||
"py_input_token": "marker"
|
||||
}
|
||||
},
|
||||
"DescribeCacheParameters": {
|
||||
"name": "DescribeCacheParameters",
|
||||
"input": {
|
||||
"shape_name": "DescribeCacheParametersMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of a specific cache parameter group to return details for.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"Source": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The parameter types to return.</p>\n <p>Valid values: <code>user</code> | <code>system</code> | <code>engine-default</code>\n </p>\n "
|
||||
},
|
||||
"MaxRecords": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n \n <p>The maximum number of records to include in the response. If more records exist than the\n specified <code>MaxRecords</code> value, a marker is included in the response so that\n the remaining results can be retrieved.</p>\n\n <p>Default: 100</p>\n<p>Constraints: minimum 20; maximum 100.</p>\n "
|
||||
},
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by <i>MaxRecords</i>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>DescribeCacheParameters</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CacheParameterGroupDetails",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>Provides an identifier to allow retrieval of paginated results.</p>\n "
|
||||
},
|
||||
"Parameters": {
|
||||
"shape_name": "ParametersList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Parameter",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ParameterName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the parameter.</p>\n "
|
||||
},
|
||||
"ParameterValue": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The value of the parameter.</p>\n "
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A description of the parameter.</p>\n "
|
||||
},
|
||||
"Source": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The source of the parameter.</p>\n "
|
||||
},
|
||||
"DataType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The valid data type for the parameter.</p>\n "
|
||||
},
|
||||
"AllowedValues": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The valid range of values for the parameter.</p>\n "
|
||||
},
|
||||
"IsModifiable": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.</p>\n "
|
||||
},
|
||||
"MinimumEngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The earliest cache engine version to which the parameter can apply.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Describes an individual setting that controls some aspect of ElastiCache behavior.</p>\n ",
|
||||
"xmlname": "Parameter"
|
||||
},
|
||||
"documentation": "\n <p>A list of <a>Parameter</a> instances.</p>\n "
|
||||
},
|
||||
"CacheNodeTypeSpecificParameters": {
|
||||
"shape_name": "CacheNodeTypeSpecificParametersList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "CacheNodeTypeSpecificParameter",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ParameterName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the parameter.</p>\n "
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A description of the parameter.</p>\n "
|
||||
},
|
||||
"Source": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The source of the parameter value.</p>\n "
|
||||
},
|
||||
"DataType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The valid data type for the parameter.</p>\n "
|
||||
},
|
||||
"AllowedValues": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The valid range of values for the parameter.</p>\n "
|
||||
},
|
||||
"IsModifiable": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.</p>\n "
|
||||
},
|
||||
"MinimumEngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The earliest cache engine version to which the parameter can apply.</p>\n "
|
||||
},
|
||||
"CacheNodeTypeSpecificValues": {
|
||||
"shape_name": "CacheNodeTypeSpecificValueList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "CacheNodeTypeSpecificValue",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheNodeType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache node type for which this value applies.</p>\n "
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The value for the cache node type.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A value that applies only to a certain cache node type.</p>\n ",
|
||||
"xmlname": "CacheNodeTypeSpecificValue"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache node types and their corresponding values for this parameter.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A parameter that has a different value for each cache node type it is applied to. For\n example, in a Redis cache cluster, a <i>cache.m1.large</i> cache node type would have a\n larger <i>maxmemory</i> value than a <i>cache.m1.small</i> type.</p>\n ",
|
||||
"xmlname": "CacheNodeTypeSpecificParameter"
|
||||
},
|
||||
"documentation": "\n <p>A list of parameters specific to a particular cache node type. Each element in the list\n contains detailed information about one parameter.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the output of a <i>DescribeCacheParameters</i> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "CacheParameterGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p> The requested cache parameter group name does not refer to an existing cache parameter\n group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>DescribeCacheParameters</i> operation returns the detailed parameter list for a\n particular cache parameter group.</p>\n <examples>\n <example>\n <description>Some of the output has been omitted for brevity. </description>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=DescribeCacheParameters\n &CacheParameterGroupName=default.memcached1.4\n &MaxRecords=100\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse>\n<DescribeCacheParametersResponse xmlns=\"http://elasticache.amazonaws.com/doc/201\n1-07-15/\">\n <DescribeCacheParametersResult>\n <CacheNodeTypeSpecificParameters>\n <CacheNodeTypeSpecificParameter>\n <CacheNodeTypeSpecificValues>\n <CacheNodeTypeSpecificValue>\n <CacheNodeType>cache.c1.xlarge</CacheNodeType>\n <Value>6000</Value>\n </CacheNodeTypeSpecificValue>\n \n (...output omitted...)\n\n </CacheNodeTypeSpecificValues>\n <DataType>integer</DataType>\n <Source>system</Source>\n <IsModifiable>false</IsModifiable>\n <Description>The maximum configurable amount of memory to use to store items, in megabytes.</Description>\n <AllowedValues>1-100000</AllowedValues>\n <ParameterName>max_cache_memory</ParameterName>\n <MinimumEngineVersion>1.4.5</MinimumEngineVersion>\n </CacheNodeTypeSpecificParameter>\n <CacheNodeTypeSpecificParameter>\n \n (...output omitted...)\n\n </CacheNodeTypeSpecificParameter>\n </CacheNodeTypeSpecificParameters>\n <Parameters>\n <Parameter>\n <ParameterValue>1024</ParameterValue>\n <DataType>integer</DataType>\n <Source>system</Source>\n <IsModifiable>false</IsModifiable>\n <Description>The backlog queue limit.</Description>\n <AllowedValues>1-10000</AllowedValues>\n <ParameterName>backlog_queue_limit</ParameterName>\n <MinimumEngineVersion>1.4.5</MinimumEngineVersion>\n </Parameter>\n \n (...output omitted...)\n \n </Parameters>\n </DescribeCacheParametersResult>\n <ResponseMetadata>\n <RequestId>0c507368-b7fe-11e0-9326-b7275b9d4a6c</RequestId>\n </ResponseMetadata>\n</DescribeCacheParametersResponse></queryresponse>\n </example>\n </examples>\n ",
|
||||
"pagination": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "Parameters",
|
||||
"non_aggregate_keys": [
|
||||
"CacheNodeTypeSpecificParameters"
|
||||
],
|
||||
"py_input_token": "marker"
|
||||
}
|
||||
},
|
||||
"DescribeCacheSecurityGroups": {
|
||||
"name": "DescribeCacheSecurityGroups",
|
||||
"input": {
|
||||
"shape_name": "DescribeCacheSecurityGroupsMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache security group to return details for.</p>\n "
|
||||
},
|
||||
"MaxRecords": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n \n <p>The maximum number of records to include in the response. If more records exist than the\n specified <code>MaxRecords</code> value, a marker is included in the response so that\n the remaining results can be retrieved.</p>\n\n <p>Default: 100</p>\n<p>Constraints: minimum 20; maximum 100.</p>\n "
|
||||
},
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by <i>MaxRecords</i>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>DescribeCacheSecurityGroups</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CacheSecurityGroupMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>Provides an identifier to allow retrieval of paginated results.</p>\n "
|
||||
},
|
||||
"CacheSecurityGroups": {
|
||||
"shape_name": "CacheSecurityGroups",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "CacheSecurityGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"OwnerId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The AWS account ID of the cache security group owner.</p>\n "
|
||||
},
|
||||
"CacheSecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache security group.</p>\n "
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The description of the cache security group.</p>\n "
|
||||
},
|
||||
"EC2SecurityGroups": {
|
||||
"shape_name": "EC2SecurityGroupList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "EC2SecurityGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the Amazon EC2 security group.</p>\n "
|
||||
},
|
||||
"EC2SecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Amazon EC2 security group.</p>\n "
|
||||
},
|
||||
"EC2SecurityGroupOwnerId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The AWS account ID of the Amazon EC2 security group owner.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Provides ownership and status information for an Amazon EC2 security group.</p>\n ",
|
||||
"xmlname": "EC2SecurityGroup"
|
||||
},
|
||||
"documentation": "\n <p>A list of Amazon EC2 security groups that are associated with this cache security\n group.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents the output of one of the following operations:</p>\n <ul>\n <li>\n <i>AuthorizeCacheSecurityGroupIngress</i>\n </li>\n <li>\n <i>CreateCacheSecurityGroup</i>\n </li>\n <li>\n <i>RevokeCacheSecurityGroupIngress</i>\n </li>\n </ul>\n ",
|
||||
"xmlname": "CacheSecurityGroup"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache security groups. Each element in the list contains detailed information\n about one group.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the output of a <i>DescribeCacheSecurityGroups</i> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "CacheSecurityGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p> The requested cache security group name does not refer to an existing cache security\n group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>DescribeCacheSecurityGroups</i> operation returns a list of cache security group\n descriptions. If a cache security group name is specified, the list will contain only\n the description of that group.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=DescribeCacheSecurityGroups\n &MaxRecords=100\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse>\n<DescribeCacheSecurityGroupsResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <DescribeCacheSecurityGroupsResult>\n <CacheSecurityGroups>\n <CacheSecurityGroup>\n <EC2SecurityGroups/>\n <CacheSecurityGroupName>default</CacheSecurityGroupName>\n <OwnerId>123456789012</OwnerId>\n <Description>default</Description>\n </CacheSecurityGroup>\n <CacheSecurityGroup>\n <EC2SecurityGroups/>\n <CacheSecurityGroupName>mycachesecuritygroup</CacheSecurityGroupName>\n <OwnerId>123456789012</OwnerId>\n <Description>My Security Group</Description>\n </CacheSecurityGroup>\n </CacheSecurityGroups>\n </DescribeCacheSecurityGroupsResult>\n <ResponseMetadata>\n <RequestId>a95360ae-b7fc-11e0-9326-b7275b9d4a6c</RequestId>\n </ResponseMetadata>\n</DescribeCacheSecurityGroupsResponse></queryresponse>\n </examples>\n ",
|
||||
"pagination": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "CacheSecurityGroups",
|
||||
"py_input_token": "marker"
|
||||
}
|
||||
},
|
||||
"DescribeCacheSubnetGroups": {
|
||||
"name": "DescribeCacheSubnetGroups",
|
||||
"input": {
|
||||
"shape_name": "DescribeCacheSubnetGroupsMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSubnetGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache subnet group to return details for.</p>\n "
|
||||
},
|
||||
"MaxRecords": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n \n <p>The maximum number of records to include in the response. If more records exist than the\n specified <code>MaxRecords</code> value, a marker is included in the response so that\n the remaining results can be retrieved.</p>\n\n <p>Default: 100</p>\n<p>Constraints: minimum 20; maximum 100.</p>\n "
|
||||
},
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by <i>MaxRecords</i>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>DescribeCacheSubnetGroups</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CacheSubnetGroupMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>Provides an identifier to allow retrieval of paginated results.</p>\n "
|
||||
},
|
||||
"CacheSubnetGroups": {
|
||||
"shape_name": "CacheSubnetGroups",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "CacheSubnetGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSubnetGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache subnet group.</p>\n "
|
||||
},
|
||||
"CacheSubnetGroupDescription": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The description of the cache subnet group.</p>\n "
|
||||
},
|
||||
"VpcId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.</p>\n "
|
||||
},
|
||||
"Subnets": {
|
||||
"shape_name": "SubnetList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Subnet",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"SubnetIdentifier": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The unique identifier for the subnet</p>\n "
|
||||
},
|
||||
"SubnetAvailabilityZone": {
|
||||
"shape_name": "AvailabilityZone",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Availability Zone.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>The Availability Zone associated with the subnet</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the subnet associated with a cache cluster. This parameter refers to subnets\n defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.</p>\n ",
|
||||
"xmlname": "Subnet"
|
||||
},
|
||||
"documentation": "\n <p>A list of subnets associated with the cache subnet group.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents the output of one of the following operations:</p>\n <ul>\n <li>\n <i>CreateCacheSubnetGroup</i>\n </li>\n <li>\n <i>ModifyCacheSubnetGroup</i>\n </li>\n </ul>\n ",
|
||||
"xmlname": "CacheSubnetGroup"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache subnet groups. Each element in the list contains detailed information\n about one group.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the output of a <i>DescribeCacheSubnetGroups</i> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "CacheSubnetGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache subnet group name does not refer to an existing cache subnet\n group.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>DescribeCacheSubnetGroups</i> operation returns a list of cache subnet group\n descriptions. If a subnet group name is specified, the list will contain only the\n description of that group.</p>\n <examples>\n <example>\n <description>Some of the output has been omitted for brevity. </description>\n <queryrequest>https://elasticache.amazonaws.com/\n ?Action=DescribeCacheSubnetGroups\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse><DescribeCacheSubnetGroupsResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <DescribeCacheSubnetGroupsResult>\n <CacheSubnetGroups>\n <CacheSubnetGroup>\n <VpcId>990524496922</VpcId>\n <CacheSubnetGroupDescription>description</CacheSubnetGroupDescription>\n <CacheSubnetGroupName>subnet_grp1</CacheSubnetGroupName>\n <Subnets>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-7c5b4115</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1c</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-7b5b4112</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1b</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-3ea6bd57</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1d</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n </Subnets>\n </CacheSubnetGroup>\n \n (...output omitted...)\n \n </CacheSubnetGroups>\n </DescribeCacheSubnetGroupsResult>\n <ResponseMetadata>\n <RequestId>31d0faee-229b-11e1-81f1-df3a2a803dad</RequestId>\n </ResponseMetadata>\n </DescribeCacheSubnetGroupsResponse></queryresponse>\n </example>\n </examples>\n ",
|
||||
"pagination": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "CacheSubnetGroups",
|
||||
"py_input_token": "marker"
|
||||
}
|
||||
},
|
||||
"DescribeEngineDefaultParameters": {
|
||||
"name": "DescribeEngineDefaultParameters",
|
||||
"input": {
|
||||
"shape_name": "DescribeEngineDefaultParametersMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheParameterGroupFamily": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group family. Valid values are: <code>memcached1.4</code>\n | <code>redis2.6</code> | <code>redis2.8</code></p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"MaxRecords": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n \n <p>The maximum number of records to include in the response. If more records exist than the\n specified <code>MaxRecords</code> value, a marker is included in the response so that\n the remaining results can be retrieved.</p>\n\n <p>Default: 100</p>\n<p>Constraints: minimum 20; maximum 100.</p>\n "
|
||||
},
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by <i>MaxRecords</i>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>DescribeEngineDefaultParameters</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "EngineDefaultsWrapper",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"EngineDefaults": {
|
||||
"shape_name": "EngineDefaults",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheParameterGroupFamily": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Specifies the name of the cache parameter group family to which the engine default\n parameters apply.</p>\n "
|
||||
},
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>Provides an identifier to allow retrieval of paginated results.</p>\n "
|
||||
},
|
||||
"Parameters": {
|
||||
"shape_name": "ParametersList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Parameter",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ParameterName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the parameter.</p>\n "
|
||||
},
|
||||
"ParameterValue": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The value of the parameter.</p>\n "
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A description of the parameter.</p>\n "
|
||||
},
|
||||
"Source": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The source of the parameter.</p>\n "
|
||||
},
|
||||
"DataType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The valid data type for the parameter.</p>\n "
|
||||
},
|
||||
"AllowedValues": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The valid range of values for the parameter.</p>\n "
|
||||
},
|
||||
"IsModifiable": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.</p>\n "
|
||||
},
|
||||
"MinimumEngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The earliest cache engine version to which the parameter can apply.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Describes an individual setting that controls some aspect of ElastiCache behavior.</p>\n ",
|
||||
"xmlname": "Parameter"
|
||||
},
|
||||
"documentation": "\n <p>Contains a list of engine default parameters.</p>\n "
|
||||
},
|
||||
"CacheNodeTypeSpecificParameters": {
|
||||
"shape_name": "CacheNodeTypeSpecificParametersList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "CacheNodeTypeSpecificParameter",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ParameterName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the parameter.</p>\n "
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A description of the parameter.</p>\n "
|
||||
},
|
||||
"Source": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The source of the parameter value.</p>\n "
|
||||
},
|
||||
"DataType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The valid data type for the parameter.</p>\n "
|
||||
},
|
||||
"AllowedValues": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The valid range of values for the parameter.</p>\n "
|
||||
},
|
||||
"IsModifiable": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.</p>\n "
|
||||
},
|
||||
"MinimumEngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The earliest cache engine version to which the parameter can apply.</p>\n "
|
||||
},
|
||||
"CacheNodeTypeSpecificValues": {
|
||||
"shape_name": "CacheNodeTypeSpecificValueList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "CacheNodeTypeSpecificValue",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheNodeType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache node type for which this value applies.</p>\n "
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The value for the cache node type.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A value that applies only to a certain cache node type.</p>\n ",
|
||||
"xmlname": "CacheNodeTypeSpecificValue"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache node types and their corresponding values for this parameter.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A parameter that has a different value for each cache node type it is applied to. For\n example, in a Redis cache cluster, a <i>cache.m1.large</i> cache node type would have a\n larger <i>maxmemory</i> value than a <i>cache.m1.small</i> type.</p>\n ",
|
||||
"xmlname": "CacheNodeTypeSpecificParameter"
|
||||
},
|
||||
"documentation": "\n <p>A list of parameters specific to a particular cache node type. Each element in the list\n contains detailed information about one parameter.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents the output of a <i>DescribeEngineDefaultParameters</i> operation.</p>\n "
|
||||
}
|
||||
}
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>DescribeEngineDefaultParameters</i> operation returns the default engine and\n system parameter information for the specified cache engine.</p>\n <examples>\n <example>\n <description>Some of the output has been omitted for brevity. </description>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=DescribeEngineDefaultParameters\n &CacheParameterGroupFamily=memcached1.4\n &MaxRecords=100\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse>\n<DescribeEngineDefaultParametersResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <DescribeEngineDefaultParametersResult>\n <EngineDefaults>\n <CacheParameterGroupFamily>memcached1.4</CacheParameterGroupFamily>\n <Parameters>\n <Parameter>\n <ParameterValue>1024</ParameterValue>\n <DataType>integer</DataType>\n <Source>system</Source>\n <IsModifiable>false</IsModifiable>\n <Description>The backlog queue limit.</Description>\n <AllowedValues>1-10000</AllowedValues>\n <ParameterName>backlog_queue_limit</ParameterName>\n <MinimumEngineVersion>1.4.5</MinimumEngineVersion>\n </Parameter>\n <Parameter>\n \n (...output omitted...)\n \n </Parameter>\n </Parameters>\n <CacheNodeTypeSpecificParameters>\n <CacheNodeTypeSpecificParameter>\n <CacheNodeTypeSpecificValues>\n <CacheNodeTypeSpecificValue>\n <CacheNodeType>cache.c1.xlarge</CacheNodeType>\n <Value>6000</Value>\n </CacheNodeTypeSpecificValue>\n \n (...output omitted...)\n \n </CacheNodeTypeSpecificValues>\n <DataType>integer</DataType>\n <Source>system</Source>\n <IsModifiable>false</IsModifiable>\n <Description>The maximum configurable amount of memory to use to store\n items, in megabytes.</Description>\n <AllowedValues>1-100000</AllowedValues>\n <ParameterName>max_cache_memory</ParameterName>\n <MinimumEngineVersion>1.4.5</MinimumEngineVersion>\n </CacheNodeTypeSpecificParameter>\n \n (...output omitted...)\n \n </CacheNodeTypeSpecificParameters>\n </EngineDefaults>\n </DescribeEngineDefaultParametersResult>\n <ResponseMetadata>\n <RequestId>061282fe-b7fd-11e0-9326-b7275b9d4a6c</RequestId>\n </ResponseMetadata>\n</DescribeEngineDefaultParametersResponse></queryresponse>\n </example>\n </examples>\n ",
|
||||
"pagination": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "EngineDefaults.Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "EngineDefaults.Parameters",
|
||||
"py_input_token": "marker"
|
||||
}
|
||||
},
|
||||
"DescribeEvents": {
|
||||
"name": "DescribeEvents",
|
||||
"input": {
|
||||
"shape_name": "DescribeEventsMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"SourceIdentifier": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier of the event source for which events will be returned. If not specified,\n then all sources are included in the response.</p>\n "
|
||||
},
|
||||
"SourceType": {
|
||||
"shape_name": "SourceType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"cache-cluster",
|
||||
"cache-parameter-group",
|
||||
"cache-security-group",
|
||||
"cache-subnet-group"
|
||||
],
|
||||
"documentation": "\n <p>The event source to retrieve events for. If no value is specified, all events are\n returned.</p>\n <p>Valid values are: <code>cache-cluster</code> | <code>cache-parameter-group</code> |\n <code>cache-security-group</code> | <code>cache-subnet-group</code></p>\n "
|
||||
},
|
||||
"StartTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The beginning of the time interval to retrieve events for, specified in ISO 8601 format.\n </p>\n "
|
||||
},
|
||||
"EndTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The end of the time interval for which to retrieve events, specified in ISO 8601 format.\n </p>\n "
|
||||
},
|
||||
"Duration": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of minutes' worth of events to retrieve.</p>\n "
|
||||
},
|
||||
"MaxRecords": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": " \n \n <p>The maximum number of records to include in the response. If more records exist than the\n specified <code>MaxRecords</code> value, a marker is included in the response so that\n the remaining results can be retrieved.</p>\n \n <p>Default: 100</p>\n<p>Constraints: minimum 20; maximum 100.</p>\n "
|
||||
},
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by <i>MaxRecords</i>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>DescribeEvents</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "EventsMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>Provides an identifier to allow retrieval of paginated results.</p>\n "
|
||||
},
|
||||
"Events": {
|
||||
"shape_name": "EventList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Event",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"SourceIdentifier": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier for the source of the event. For example, if the event occurred at the\n cache cluster level, the identifier would be the name of the cache cluster.</p>\n "
|
||||
},
|
||||
"SourceType": {
|
||||
"shape_name": "SourceType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"cache-cluster",
|
||||
"cache-parameter-group",
|
||||
"cache-security-group",
|
||||
"cache-subnet-group"
|
||||
],
|
||||
"documentation": "\n <p>Specifies the origin of this event - a cache cluster, a parameter group, a security\n group, etc.</p>\n "
|
||||
},
|
||||
"Message": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The text of the event.</p>\n "
|
||||
},
|
||||
"Date": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the event occurred.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents a single occurrence of something interesting within the system. Some examples\n of events are creating a cache cluster, adding or removing a cache node, or rebooting a\n node.</p>\n ",
|
||||
"xmlname": "Event"
|
||||
},
|
||||
"documentation": "\n <p>A list of events. Each element in the list contains detailed information about one\n event.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the output of a <i>DescribeEvents</i> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>DescribeEvents</i> operation returns events related to cache clusters, cache\n security groups, and cache parameter groups. You can obtain events specific to a\n particular cache cluster, cache security group, or cache parameter group by providing\n the name as a parameter.</p>\n <p>By default, only the events occurring within the last hour are returned; however, you can\n retrieve up to 14 days' worth of events if necessary.</p>\n <examples>\n <example>\n <description>Some of the output has been omitted for brevity. </description>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=DescribeEvents\n &MaxRecords=100\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential>\n</queryrequest>\n <queryresponse>\n<DescribeEventsResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\"> \n <DescribeEventsResult> \n <Events> \n <Event> \n <Message>Cache cluster created</Message> \n <SourceType>cache-cluster</SourceType> \n <Date>2014-04-01T18:22:18.202Z</Date> \n <SourceIdentifier>my-redis-primary</SourceIdentifier> \n </Event> \n \n (...output omitted...)\n \n </Events> \n </DescribeEventsResult> \n <ResponseMetadata> \n <RequestId>e21c81b4-b9cd-11e3-8a16-7978bb24ffdf</RequestId> \n </ResponseMetadata> \n</DescribeEventsResponse></queryresponse>\n </example>\n </examples>\n ",
|
||||
"pagination": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "Events",
|
||||
"py_input_token": "marker"
|
||||
}
|
||||
},
|
||||
"DescribeReplicationGroups": {
|
||||
"name": "DescribeReplicationGroups",
|
||||
"input": {
|
||||
"shape_name": "DescribeReplicationGroupsMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ReplicationGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier for the replication group to be described. This parameter is not case\n sensitive.</p>\n <p>If you do not specify this parameter, information about all replication groups is\n returned.</p>\n "
|
||||
},
|
||||
"MaxRecords": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n \n <p>The maximum number of records to include in the response. If more records exist than the\n specified <code>MaxRecords</code> value, a marker is included in the response so that\n the remaining results can be retrieved.</p>\n\n <p>Default: 100</p>\n<p>Constraints: minimum 20; maximum 100.</p>\n "
|
||||
},
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by <i>MaxRecords</i>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>DescribeReplicationGroups</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ReplicationGroupMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>Provides an identifier to allow retrieval of paginated results.</p>\n "
|
||||
},
|
||||
"ReplicationGroups": {
|
||||
"shape_name": "ReplicationGroupList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "ReplicationGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ReplicationGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier for the replication group.</p>\n "
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The description of the replication group.</p>\n "
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of this replication group - <i>creating</i>, <i>available</i>, etc.</p>\n "
|
||||
},
|
||||
"PendingModifiedValues": {
|
||||
"shape_name": "ReplicationGroupPendingModifiedValues",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"PrimaryClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The primary cluster ID which will be applied immediately (if\n <code>--apply-immediately</code> was specified), or during the next maintenance\n window.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A group of settings to be applied to the replication group, either immediately or during\n the next maintenance window.</p>\n "
|
||||
},
|
||||
"MemberClusters": {
|
||||
"shape_name": "ClusterIdList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "ClusterId"
|
||||
},
|
||||
"documentation": "\n <p>The names of all the cache clusters that are part of this replication group.</p>\n "
|
||||
},
|
||||
"NodeGroups": {
|
||||
"shape_name": "NodeGroupList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "NodeGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"NodeGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier for the node group. A replication group contains only one node group;\n therefore, the node group ID is 0001.</p>\n "
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of this replication group - <i>creating</i>, <i>available</i>, etc.</p>\n "
|
||||
},
|
||||
"PrimaryEndpoint": {
|
||||
"shape_name": "Endpoint",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Address": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The DNS hostname of the cache node.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number that the cache engine is listening on.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the information required for client programs to connect to a cache node.</p>\n "
|
||||
},
|
||||
"NodeGroupMembers": {
|
||||
"shape_name": "NodeGroupMemberList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "NodeGroupMember",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of the cache cluster to which the node belongs.</p>\n "
|
||||
},
|
||||
"CacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of the node within its cache cluster. A node ID is a numeric identifier (0001,\n 0002, etc.).</p>\n "
|
||||
},
|
||||
"ReadEndpoint": {
|
||||
"shape_name": "Endpoint",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Address": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The DNS hostname of the cache node.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number that the cache engine is listening on.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the information required for client programs to connect to a cache node.</p>\n "
|
||||
},
|
||||
"PreferredAvailabilityZone": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Availability Zone in which the node is located.</p>\n "
|
||||
},
|
||||
"CurrentRole": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The role that is currently assigned to the node - <i>primary</i> or <i>replica</i>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents a single node within a node group.</p>\n ",
|
||||
"xmlname": "NodeGroupMember"
|
||||
},
|
||||
"documentation": "\n <p>A list containing information about individual nodes within the node group.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents a collection of cache nodes in a replication group.</p>\n ",
|
||||
"xmlname": "NodeGroup"
|
||||
},
|
||||
"documentation": "\n <p>A single element list with information about the nodes in the replication group.</p>\n "
|
||||
},
|
||||
"SnapshottingClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache cluster ID that is used as the daily snapshot source for the replication\n group.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Contains all of the attributes of a specific replication group.</p>\n ",
|
||||
"xmlname": "ReplicationGroup"
|
||||
},
|
||||
"documentation": "\n <p>A list of replication groups. Each item in the list contains detailed information about\n one replication group.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the output of a <i>DescribeReplicationGroups</i> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "ReplicationGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The specified replication group does not exist.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>DescribeReplicationGroups</i> operation returns information about a particular\n replication group. If no identifier is specified, <i>DescribeReplicationGroups</i>\n returns information about all replication groups.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=DescribeReplicationGroups\n &MaxRecords=100\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse><DescribeReplicationGroupsResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\"> \n <DescribeReplicationGroupsResult> \n <ReplicationGroups> \n <ReplicationGroup> \n <SnapshottingClusterId>my-redis-primary</SnapshottingClusterId> \n <MemberClusters> \n <ClusterId>my-redis-primary</ClusterId> \n </MemberClusters> \n <NodeGroups> \n <NodeGroup> \n <NodeGroupId>0001</NodeGroupId> \n <PrimaryEndpoint> \n <Port>6379</Port> \n <Address>my-repgroup.q68zge.ng.0001.use1devo.elmo-dev.amazonaws.com</Address> \n </PrimaryEndpoint> \n <Status>available</Status> \n <NodeGroupMembers> \n <NodeGroupMember> \n <CacheClusterId>my-redis-primary</CacheClusterId> \n <ReadEndpoint> \n <Port>6379</Port> \n <Address>my-redis-primary.q68zge.0001.use1devo.elmo-dev.amazonaws.com</Address> \n </ReadEndpoint> \n <PreferredAvailabilityZone>us-east-1d</PreferredAvailabilityZone> \n <CacheNodeId>0001</CacheNodeId> \n <CurrentRole>primary</CurrentRole> \n </NodeGroupMember> \n </NodeGroupMembers> \n </NodeGroup> \n </NodeGroups> \n <ReplicationGroupId>my-repgroup</ReplicationGroupId> \n <Status>available</Status> \n <PendingModifiedValues /> \n <Description>My replication group</Description> \n </ReplicationGroup> \n </ReplicationGroups> \n </DescribeReplicationGroupsResult> \n <ResponseMetadata> \n <RequestId>144745b0-b9d3-11e3-8a16-7978bb24ffdf</RequestId> \n </ResponseMetadata> \n</DescribeReplicationGroupsResponse>\n</queryresponse>\n </examples>\n ",
|
||||
"pagination": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "ReplicationGroups",
|
||||
"py_input_token": "marker"
|
||||
}
|
||||
},
|
||||
"DescribeReservedCacheNodes": {
|
||||
"name": "DescribeReservedCacheNodes",
|
||||
"input": {
|
||||
"shape_name": "DescribeReservedCacheNodesMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ReservedCacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The reserved cache node identifier filter value. Use this parameter to show only the\n reservation that matches the specified reservation ID.</p>\n "
|
||||
},
|
||||
"ReservedCacheNodesOfferingId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The offering identifier filter value. Use this parameter to show only purchased\n reservations matching the specified offering identifier.</p>\n "
|
||||
},
|
||||
"CacheNodeType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache node type filter value. Use this parameter to show only those reservations\n matching the specified cache node type.</p>\n "
|
||||
},
|
||||
"Duration": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The duration filter value, specified in years or seconds. Use this parameter to show only\n reservations for this duration.</p>\n <p>Valid Values: <code>1 | 3 | 31536000 | 94608000</code></p>\n "
|
||||
},
|
||||
"ProductDescription": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The product description filter value. Use this parameter to show only those reservations\n matching the specified product description.</p>\n "
|
||||
},
|
||||
"OfferingType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The offering type filter value. Use this parameter to show only the available offerings\n matching the specified offering type.</p>\n <p>Valid values: <code>\"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"\n </code></p>\n "
|
||||
},
|
||||
"MaxRecords": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n \n <p>The maximum number of records to include in the response. If more records exist than the\n specified <code>MaxRecords</code> value, a marker is included in the response so that\n the remaining results can be retrieved.</p>\n\n <p>Default: 100</p>\n<p>Constraints: minimum 20; maximum 100.</p>\n "
|
||||
},
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by <i>MaxRecords</i>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>DescribeReservedCacheNodes</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ReservedCacheNodeMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>Provides an identifier to allow retrieval of paginated results.</p>\n "
|
||||
},
|
||||
"ReservedCacheNodes": {
|
||||
"shape_name": "ReservedCacheNodeList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "ReservedCacheNode",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ReservedCacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The unique identifier for the reservation.</p>\n "
|
||||
},
|
||||
"ReservedCacheNodesOfferingId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The offering identifier.</p>\n "
|
||||
},
|
||||
"CacheNodeType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache node type for the reserved cache nodes.</p>\n "
|
||||
},
|
||||
"StartTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The time the reservation started.</p>\n "
|
||||
},
|
||||
"Duration": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The duration of the reservation in seconds.</p>\n "
|
||||
},
|
||||
"FixedPrice": {
|
||||
"shape_name": "Double",
|
||||
"type": "double",
|
||||
"documentation": "\n <p>The fixed price charged for this reserved cache node.</p>\n "
|
||||
},
|
||||
"UsagePrice": {
|
||||
"shape_name": "Double",
|
||||
"type": "double",
|
||||
"documentation": "\n <p>The hourly price charged for this reserved cache node.</p>\n "
|
||||
},
|
||||
"CacheNodeCount": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of cache nodes that have been reserved.</p>\n "
|
||||
},
|
||||
"ProductDescription": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The description of the reserved cache node.</p>\n "
|
||||
},
|
||||
"OfferingType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The offering type of this reserved cache node.</p>\n "
|
||||
},
|
||||
"State": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The state of the reserved cache node.</p>\n "
|
||||
},
|
||||
"RecurringCharges": {
|
||||
"shape_name": "RecurringChargeList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "RecurringCharge",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"RecurringChargeAmount": {
|
||||
"shape_name": "Double",
|
||||
"type": "double",
|
||||
"documentation": "\n <p>The monetary amount of the recurring charge.</p>\n "
|
||||
},
|
||||
"RecurringChargeFrequency": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The frequency of the recurring charge.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Contains the specific price and frequency of a recurring charges for a reserved cache\n node, or for a reserved cache node offering.</p>\n ",
|
||||
"xmlname": "RecurringCharge"
|
||||
},
|
||||
"documentation": "\n <p>The recurring price charged to run this reserved cache node.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents the output of a <i>PurchaseReservedCacheNodesOffering</i> operation.</p>\n ",
|
||||
"xmlname": "ReservedCacheNode"
|
||||
},
|
||||
"documentation": "\n <p>A list of reserved cache nodes. Each element in the list contains detailed information\n about one node.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the output of a <i>DescribeReservedCacheNodes</i> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "ReservedCacheNodeNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested reserved cache node was not found.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>DescribeReservedCacheNodes</i> operation returns information about reserved cache\n nodes for this account, or about a specified reserved cache node.</p>\n <examples>\n <queryrequest>https://elasticache.amazonaws.com/\n ?Action=DescribeReservedCacheNodes\n &ReservedCacheNodeId=customerSpecifiedID\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse><DescribeReservedCacheNodesResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <DescribeReservedCacheNodesResult>\n <ReservedCacheNodes>\n <ReservedCacheNode>\n <OfferingType>Medium Utilization</OfferingType>\n <RecurringCharges/>\n <ProductDescription>memcached</ProductDescription>\n <ReservedCacheNodesOfferingId>649fd0c8-cf6d-47a0-bfa6-060f8e75e95f</ReservedCacheNodesOfferingId>\n <State>payment-failed</State>\n <ReservedCacheNodeId>myreservationid</ReservedCacheNodeId>\n <CacheNodeCount>1</CacheNodeCount>\n <StartTime>2010-12-15T00:25:14.131Z</StartTime>\n <Duration>31536000</Duration>\n <FixedPrice>227.5</FixedPrice>\n <UsagePrice>0.046</UsagePrice>\n <CacheNodeType>cache.m1.small</CacheNodeType>\n </ReservedCacheNode>\n </DescribeReservedCacheNodesResult>\n <ResponseMetadata>\n <RequestId>c695119b-2961-11e1-bd06-6fe008f046c3</RequestId>\n </ResponseMetadata>\n</DescribeReservedCacheNodesResponse>\n</queryresponse>\n </examples>\n ",
|
||||
"pagination": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "ReservedCacheNodes",
|
||||
"py_input_token": "marker"
|
||||
}
|
||||
},
|
||||
"DescribeReservedCacheNodesOfferings": {
|
||||
"name": "DescribeReservedCacheNodesOfferings",
|
||||
"input": {
|
||||
"shape_name": "DescribeReservedCacheNodesOfferingsMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ReservedCacheNodesOfferingId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The offering identifier filter value. Use this parameter to show only the available\n offering that matches the specified reservation identifier.</p>\n <p>Example: <code>438012d3-4052-4cc7-b2e3-8d3372e0e706</code></p>\n "
|
||||
},
|
||||
"CacheNodeType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache node type filter value. Use this parameter to show only the available offerings\n matching the specified cache node type.</p>\n "
|
||||
},
|
||||
"Duration": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Duration filter value, specified in years or seconds. Use this parameter to show only\n reservations for a given duration.</p>\n <p>Valid Values: <code>1 | 3 | 31536000 | 94608000</code></p>\n "
|
||||
},
|
||||
"ProductDescription": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The product description filter value. Use this parameter to show only the available\n offerings matching the specified product description.</p>\n "
|
||||
},
|
||||
"OfferingType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The offering type filter value. Use this parameter to show only the available offerings\n matching the specified offering type.</p>\n <p>Valid Values: <code>\"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"\n </code></p>\n "
|
||||
},
|
||||
"MaxRecords": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n \n <p>The maximum number of records to include in the response. If more records exist than the\n specified <code>MaxRecords</code> value, a marker is included in the response so that\n the remaining results can be retrieved.</p>\n \n <p>Default: 100</p>\n<p>Constraints: minimum 20; maximum 100.</p>\n "
|
||||
},
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by <i>MaxRecords</i>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>DescribeReservedCacheNodesOfferings</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ReservedCacheNodesOfferingMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>Provides an identifier to allow retrieval of paginated results.</p>\n "
|
||||
},
|
||||
"ReservedCacheNodesOfferings": {
|
||||
"shape_name": "ReservedCacheNodesOfferingList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "ReservedCacheNodesOffering",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ReservedCacheNodesOfferingId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A unique identifier for the reserved cache node offering.</p>\n "
|
||||
},
|
||||
"CacheNodeType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache node type for the reserved cache node.</p>\n "
|
||||
},
|
||||
"Duration": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The duration of the offering. in seconds.</p>\n "
|
||||
},
|
||||
"FixedPrice": {
|
||||
"shape_name": "Double",
|
||||
"type": "double",
|
||||
"documentation": "\n <p>The fixed price charged for this offering.</p>\n "
|
||||
},
|
||||
"UsagePrice": {
|
||||
"shape_name": "Double",
|
||||
"type": "double",
|
||||
"documentation": "\n <p>The hourly price charged for this offering.</p>\n "
|
||||
},
|
||||
"ProductDescription": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache engine used by the offering.</p>\n "
|
||||
},
|
||||
"OfferingType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The offering type.</p>\n "
|
||||
},
|
||||
"RecurringCharges": {
|
||||
"shape_name": "RecurringChargeList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "RecurringCharge",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"RecurringChargeAmount": {
|
||||
"shape_name": "Double",
|
||||
"type": "double",
|
||||
"documentation": "\n <p>The monetary amount of the recurring charge.</p>\n "
|
||||
},
|
||||
"RecurringChargeFrequency": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The frequency of the recurring charge.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Contains the specific price and frequency of a recurring charges for a reserved cache\n node, or for a reserved cache node offering.</p>\n ",
|
||||
"xmlname": "RecurringCharge"
|
||||
},
|
||||
"documentation": "\n <p>The recurring price charged to run this reserved cache node.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Describes all of the attributes of a reserved cache node offering.</p>\n ",
|
||||
"xmlname": "ReservedCacheNodesOffering"
|
||||
},
|
||||
"documentation": "\n <p>A list of reserved cache node offerings. Each element in the list contains detailed\n information about one offering.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the output of a <i>DescribeReservedCacheNodesOfferings</i> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "ReservedCacheNodesOfferingNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache node offering does not exist.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>DescribeReservedCacheNodesOfferings</i> operation lists available reserved cache\n node offerings.</p>\n <examples>\n <queryrequest>https://elasticache.amazonaws.com/\n ?Action=DescribeReservedCacheNodesOfferings\n &ReservedCacheNodesOfferingId=438012d3-4052-4cc7-b2e3-8d3372e0e706\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse><DescribeReservedCacheNodesOfferingsResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <DescribeReservedCacheNodesOfferingsResult>\n <ReservedCacheNodesOfferings>\n <ReservedCacheNodesOffering>\n <Duration>31536000</Duration>\n <OfferingType>Heavy Utilization</OfferingType>\n <RecurringCharges>\n <RecurringCharge>\n <RecurringChargeFrequency>Hourly</RecurringChargeFrequency>\n <RecurringChargeAmount>0.123</RecurringChargeAmount>\n </RecurringCharge>\n </RecurringCharges>\n <FixedPrice>162.0</FixedPrice>\n <ProductDescription>memcached</ProductDescription>\n <UsagePrice>0.0</UsagePrice>\n <ReservedCacheNodesOfferingId>SampleOfferingId</ReservedCacheNodesOfferingId>\n <CacheNodeType>cache.m1.small</CacheNodeType>\n </ReservedCacheNodesOffering>\n </ReservedCacheNodesOfferings>\n </DescribeReservedCacheNodesOfferingsResult>\n <ResponseMetadata>\n <RequestId>521b420a-2961-11e1-bd06-6fe008f046c3</RequestId>\n </ResponseMetadata>\n</DescribeReservedCacheNodesOfferingsResponse>\n</queryresponse>\n </examples>\n ",
|
||||
"pagination": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "ReservedCacheNodesOfferings",
|
||||
"py_input_token": "marker"
|
||||
}
|
||||
},
|
||||
"DescribeSnapshots": {
|
||||
"name": "DescribeSnapshots",
|
||||
"input": {
|
||||
"shape_name": "DescribeSnapshotsMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A user-supplied cluster identifier. If this parameter is specified, only snapshots\n associated with that specific cache cluster will be described.</p>\n "
|
||||
},
|
||||
"SnapshotName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A user-supplied name of the snapshot. If this parameter is specified, only this snapshot\n will be described.</p>\n "
|
||||
},
|
||||
"SnapshotSource": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>If set to <code>system</code>, the output shows snapshots that were automatically created by ElastiCache. \n If set to <code>user</code> the output shows snapshots that were manually created. \n If omitted, the output shows both automatically and manually created snapshots.</p>\n "
|
||||
},
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": " \n <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by <i>MaxRecords</i>.</p>\n "
|
||||
},
|
||||
"MaxRecords": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": " \n \n <p>The maximum number of records to include in the response. If more records exist than the\n specified <code>MaxRecords</code> value, a marker is included in the response so that\n the remaining results can be retrieved.</p>\n \n <p>Default: 50</p>\n<p>Constraints: minimum 20; maximum 50.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>DescribeSnapshotsMessage</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "DescribeSnapshotsListMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Marker": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n \n <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by <i>MaxRecords</i>.</p>\n \n "
|
||||
},
|
||||
"Snapshots": {
|
||||
"shape_name": "SnapshotList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Snapshot",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"SnapshotName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <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>\n "
|
||||
},
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The user-supplied identifier of the source cache cluster.</p>\n "
|
||||
},
|
||||
"SnapshotStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the snapshot. Valid values: <code>creating</code> | <code>available</code>\n | <code>restoring</code> | <code>copying</code> | <code>deleting</code>.</p>\n "
|
||||
},
|
||||
"SnapshotSource": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Indicates whether the snapshot is from an automatic backup (<code>automated</code>) or was created manually (<code>manual</code>).</p>\n "
|
||||
},
|
||||
"CacheNodeType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the compute and memory capacity node type for the source cache cluster.</p>\n "
|
||||
},
|
||||
"Engine": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache engine (<i>memcached</i> or <i>redis</i>) used by the source cache\n cluster.</p>\n "
|
||||
},
|
||||
"EngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The version of the cache engine version that is used by the source cache cluster.</p>\n "
|
||||
},
|
||||
"NumCacheNodes": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of cache nodes in the source cache cluster.</p>\n "
|
||||
},
|
||||
"PreferredAvailabilityZone": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Availability Zone in which the source cache cluster is located.</p>\n "
|
||||
},
|
||||
"CacheClusterCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the source cache cluster was created.</p>\n "
|
||||
},
|
||||
"PreferredMaintenanceWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p> The time range (in UTC) during which weekly system maintenance can occur on the source\n cache cluster.</p>\n "
|
||||
},
|
||||
"TopicArn": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon Resource Name (ARN) for the topic used by the source cache cluster for\n publishing notifications.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number used by each cache nodes in the source cache cluster.</p>\n "
|
||||
},
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache parameter group that is associated with the source cache cluster.</p>\n "
|
||||
},
|
||||
"CacheSubnetGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache subnet group associated with the source cache cluster.</p>\n "
|
||||
},
|
||||
"VpcId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the\n source cache cluster.</p>\n "
|
||||
},
|
||||
"AutoMinorVersionUpgrade": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>For the source cache cluster, indicates whether minor version patches are applied\n automatically (<code>true</code>) or not (<code>false</code>).</p>\n "
|
||||
},
|
||||
"SnapshotRetentionLimit": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.</p>\n <p>For manual snapshots, this field reflects the <i>SnapshotRetentionLimit</i> for the\n source cache cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the <i>DeleteSnapshot</i>\n action. </p>\n <p><b>Important</b><br>If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</p>\n "
|
||||
},
|
||||
"SnapshotWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The daily time range during which ElastiCache takes daily snapshots of the source cache\n cluster.</p>\n "
|
||||
},
|
||||
"NodeSnapshots": {
|
||||
"shape_name": "NodeSnapshotList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "NodeSnapshot",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache node identifier for the node in the source cache cluster.</p>\n "
|
||||
},
|
||||
"CacheSize": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The size of the cache on the source cache node.</p>\n "
|
||||
},
|
||||
"CacheNodeCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the cache node was created in the source cache cluster.</p>\n "
|
||||
},
|
||||
"SnapshotCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the source node's metadata and cache data set was obtained for the snapshot.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents an individual cache node in a snapshot of a cache cluster.</p>\n ",
|
||||
"xmlname": "NodeSnapshot"
|
||||
},
|
||||
"documentation": "\n <p>A list of the cache nodes in the source cache cluster.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents a copy of an entire cache cluster as of the time when the snapshot was taken.</p>\n ",
|
||||
"xmlname": "Snapshot"
|
||||
},
|
||||
"documentation": "\n <p>A list of snapshots. Each item in the list contains detailed information about one\n snapshot.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the output of a <i>DescribeSnapshots</i> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "CacheClusterNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache cluster ID does not refer to an existing cache cluster.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "SnapshotNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested snapshot name does not refer to an existing snapshot.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>DescribeSnapshots</i> operation returns information about cache cluster snapshots.\n By default, <i>DescribeSnapshots</i> lists all of your snapshots; it can optionally\n describe a single snapshot, or just the snapshots associated with a particular cache\n cluster.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=DescribeSnapshots\n &MaxRecords=50\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse><DescribeSnapshotsResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\"> \n <DescribeSnapshotsResult> \n <Snapshots> \n <Snapshot> \n <CacheClusterId>my-redis-primary</CacheClusterId> \n <Port>6379</Port> \n <CacheNodeType>cache.m1.small</CacheNodeType> \n <CacheParameterGroupName>default.redis2.8</CacheParameterGroupName> \n <Engine>redis</Engine> \n <PreferredAvailabilityZone>us-east-1d</PreferredAvailabilityZone> \n <CacheClusterCreateTime>2014-04-01T18:46:57.972Z</CacheClusterCreateTime> \n <EngineVersion>2.8.6</EngineVersion> \n <SnapshotSource>manual</SnapshotSource> \n <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade> \n <PreferredMaintenanceWindow>wed:09:00-wed:10:00</PreferredMaintenanceWindow> \n <SnapshotName>my-manual-snapshot</SnapshotName> \n <SnapshotRetentionLimit>5</SnapshotRetentionLimit> \n <NodeSnapshots> \n <NodeSnapshot> \n <SnapshotCreateTime>2014-04-01T18:54:12Z</SnapshotCreateTime> \n <CacheNodeCreateTime>2014-04-01T18:46:57.972Z</CacheNodeCreateTime> \n <CacheNodeId>0001</CacheNodeId> \n <CacheSize>3 MB</CacheSize> \n </NodeSnapshot> \n </NodeSnapshots> \n <SnapshotStatus>creating</SnapshotStatus> \n <NumCacheNodes>1</NumCacheNodes> \n <SnapshotWindow>07:30-08:30</SnapshotWindow> \n </Snapshot> \n </Snapshots> \n </DescribeSnapshotsResult> \n <ResponseMetadata> \n <RequestId>51b0b25e-b9cf-11e3-8a16-7978bb24ffdf</RequestId> \n </ResponseMetadata> \n</DescribeSnapshotsResponse>\n</queryresponse>\n </examples>\n "
|
||||
},
|
||||
"ModifyCacheCluster": {
|
||||
"name": "ModifyCacheCluster",
|
||||
"input": {
|
||||
"shape_name": "ModifyCacheClusterMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache cluster identifier. This value is stored as a lowercase string.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"NumCacheNodes": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of cache nodes that the cache cluster should have. \n If the value for <code>NumCacheNodes</code> is greater than the sum of the number of current cache nodes and \n the number of cache nodes pending creation (which may be zero), then more nodes will be added. \n If the value is less than the number of existing cache nodes, then nodes will be removed. \n If the value is equal to the number of current cache nodes, then any pending add or remove requests are canceled.</p>\n <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>\n <p>For cache clusters running Redis, the value of <code>NumCacheNodes</code>must be 1.</p>\n <p><b>Note:</b><br>Adding or removing Memcached cache nodes can be applied immediately or as a pending action. See <code>ApplyImmediately</code>.<br>\n A pending action to modify the number of cache nodes in a cluster during its maintenance window, \n whether by adding or removing nodes in accordance with the scale out architecture, is not queued. \n The customer's latest request to add or remove nodes to the cluster overrides any previous pending actions to modify the \n number of cache nodes in the cluster. \n For example, a request to remove 2 nodes would override a previous pending action to remove 3 nodes. \n Similarly, a request to add 2 nodes would override a previous pending action to remove 3 nodes and vice versa. \n As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, \n a request to add nodes does not automatically override a previous pending action to add nodes. \n The customer can modify the previous pending action to add more nodes or explicitly cancel the pending request and retry the new request. \n To cancel pending actions to modify the number of cache nodes in a cluster, use the <code>ModifyCacheCluster</code> request and \n set <code>NumCacheNodes</code> equal to the number of cache nodes currently in the cache cluster.</p>\n "
|
||||
},
|
||||
"CacheNodeIdsToRemove": {
|
||||
"shape_name": "CacheNodeIdsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "CacheNodeId"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002,\n etc.). This parameter is only valid when NumCacheNodes is less than the existing number\n of cache nodes. The number of cache node IDs supplied in this parameter must match the\n difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is\n greater, and the value of <i>NumCacheNodes</i> in the request.</p>\n <p>For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this \n <code>ModifyCacheCluser</code> call is 5, you must list 2 (7 - 5) cache node IDs to remove.</p>\n "
|
||||
},
|
||||
"CacheSecurityGroupNames": {
|
||||
"shape_name": "CacheSecurityGroupNameList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "CacheSecurityGroupName"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache security group names to authorize on this cache cluster. This change is\n asynchronously applied as soon as possible.</p>\n <p>This parameter can be used only with clusters that are created outside of an Amazon\n Virtual Private Cloud (VPC).</p>\n <p>Constraints: Must contain no more than 255 alphanumeric characters. Must not be\n \"Default\".</p>\n "
|
||||
},
|
||||
"SecurityGroupIds": {
|
||||
"shape_name": "SecurityGroupIdsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "SecurityGroupId"
|
||||
},
|
||||
"documentation": "\n <p>Specifies the VPC Security Groups associated with the cache cluster.</p>\n <p>This parameter can be used only with clusters that are created in an Amazon Virtual\n Private Cloud (VPC).</p>\n "
|
||||
},
|
||||
"PreferredMaintenanceWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The weekly time range (in UTC) during which system maintenance can occur. Note that\n system maintenance may result in an outage. This change is made immediately. If you are\n moving this window to the current time, there must be at least 120 minutes between the\n current time and end of the window to ensure that pending changes are applied.</p>\n "
|
||||
},
|
||||
"NotificationTopicArn": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.</p>\n <note>The Amazon SNS topic owner must be same as the cache cluster owner. </note>\n "
|
||||
},
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group to apply to this cache cluster. This change is\n asynchronously applied as soon as possible for parameters when the\n <i>ApplyImmediately</i> parameter is specified as <i>true</i> for this request.</p>\n "
|
||||
},
|
||||
"NotificationTopicStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the Amazon SNS notification topic. Notifications are sent only if the\n status is <i>active</i>.</p>\n <p>Valid values: <code>active</code> | <code>inactive</code></p>\n "
|
||||
},
|
||||
"ApplyImmediately": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>If <code>true</code>, this parameter causes the modifications in this request and any\n pending modifications to be applied, asynchronously and as soon as possible, regardless\n of the <i>PreferredMaintenanceWindow</i> setting for the cache cluster.</p>\n <p>If <code>false</code>, then changes to the cache cluster are applied on the next\n maintenance reboot, or the next failure reboot, whichever occurs first.</p>\n <important>If you perform a <code>ModifyCacheCluster</code> before a pending modification is applied, the pending modification\n is replaced by the newer modification.</important>\n <p>Valid values: <code>true</code> | <code>false</code></p>\n <p>Default: <code>false</code></p>\n "
|
||||
},
|
||||
"EngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The upgraded version of the cache engine to be run on the cache nodes.</p>\n "
|
||||
},
|
||||
"AutoMinorVersionUpgrade": {
|
||||
"shape_name": "BooleanOptional",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>If <code>true</code>, then minor engine upgrades will be applied automatically to the\n cache cluster during the maintenance window.</p>\n <p>Valid values: <code>true</code> | <code>false</code></p>\n <p>Default: <code>true</code></p>\n "
|
||||
},
|
||||
"SnapshotRetentionLimit": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set <i>SnapshotRetentionLimit</i> to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.</p>\n <p><b>Important</b><br>If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</p>\n "
|
||||
},
|
||||
"SnapshotWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster. </p>\n "
|
||||
},
|
||||
"AZMode": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or \n created across multiple Availability Zones.</p>\n <p>Valid values: <code>single-az</code> | <code>cross-az</code>.</p>\n <p>This option is only supported for Memcached cache clusters.</p>\n <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> \n <p>Only newly created nodes will be located in different Availability Zones. For instructions on how to move existing Memcached\n nodes to different Availability Zones, see the <b>Availability Zone Considerations</b>\n section of <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheNode.Memcached.html\">Cache Node Considerations for Memcached</a>.</p>\n </note>\n "
|
||||
},
|
||||
"NewAvailabilityZones": {
|
||||
"shape_name": "PreferredAvailabilityZoneList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "PreferredAvailabilityZone"
|
||||
},
|
||||
"documentation": "\n <p>The list of Availability Zones where the new Memcached cache nodes will be created.</p> \n <p>This parameter is only valid when <code>NumCacheNodes</code> in the request is greater \n than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). \n The number of Availability Zones supplied in this list must match the cache nodes being added in this request.</p>\n <p>\n This option is only supported on Memcached clusters. \n </p>\n <p>Scenarios:\n <ul>\n <li>\n<b>Scenario 1:</b> You have 3 active nodes and wish to add 2 nodes.<br>\n Specify <code>NumCacheNodes=5</code> (3 + 2) and opitonally specify two Availability Zones for the two new nodes.</li>\n <li>\n<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.<br>\n Specify <code>NumCacheNodes=6</code> ((3 + 2) + 1)</li> and optionally specify an Availability Zone for the new node.\n <li>\n<b>Scenario 3:</b> You want to cancel all pending actions.<br>\n You want to cancel all pending actions.\n Specify <code>NumCacheNodes=3</code> (the original number of nodes).\n <note>You cannot cancel just some pending operations. If you want to cancel a subset of\n the pending operations, cancel all of them, then re-request those you want.</note>\n</li>\n </ul>\n </p>\n <p>\n The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, \n add 0 nodes by setting <code>NumCacheNodes</code> to the number of current nodes. </p>\n <p>\n If <code>cross-az</code> is specified, existing Memcached nodes remain in their current Availability Zone. \n Only newly created nodes can be located in different Availability Zones. \n For guidance on how to move existing Memcached nodes to different Availability Zones, see the\n <b>Availability Zone Considerations</b> section of \n <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/CacheNode.Memcached.html\">Cache Node Considerations for Memcached</a>.\n </p>\n <p>Example: <code>NewAvailabilityZones.member.1=us-east-1a&NewAvailabilityZones.member.2=us-east-1b&NewAvailabilityZones.member.3=us-east-1d</code></p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>ModifyCacheCluster</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CacheClusterWrapper",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheCluster": {
|
||||
"shape_name": "CacheCluster",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The user-supplied identifier of the cache cluster. This is a unique key that identifies a\n cache cluster.</p>\n "
|
||||
},
|
||||
"ConfigurationEndpoint": {
|
||||
"shape_name": "Endpoint",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Address": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The DNS hostname of the cache node.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number that the cache engine is listening on.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the information required for client programs to connect to a cache node.</p>\n "
|
||||
},
|
||||
"ClientDownloadLandingPage": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The URL of the web page where you can download the latest ElastiCache client library.</p>\n "
|
||||
},
|
||||
"CacheNodeType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the compute and memory capacity node type for the cache cluster.</p>\n "
|
||||
},
|
||||
"Engine": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache engine (<i>memcached</i> or <i>redis</i>) to be used for this cache\n cluster.</p>\n "
|
||||
},
|
||||
"EngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The version of the cache engine version that is used in this cache cluster.</p>\n "
|
||||
},
|
||||
"CacheClusterStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of this cache cluster - <i>creating</i>, <i>available</i>, etc.</p>\n "
|
||||
},
|
||||
"NumCacheNodes": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of cache nodes in the cache cluster.</p>\n "
|
||||
},
|
||||
"PreferredAvailabilityZone": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Availability Zone in which the cache cluster is located or \n \"Multiple\" if the cache nodes are located in different Availability Zones.</p>\n "
|
||||
},
|
||||
"CacheClusterCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the cache cluster was created.</p>\n "
|
||||
},
|
||||
"PreferredMaintenanceWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The time range (in UTC) during which weekly system maintenance can occur.</p>\n "
|
||||
},
|
||||
"PendingModifiedValues": {
|
||||
"shape_name": "PendingModifiedValues",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"NumCacheNodes": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The new number of cache nodes for the cache cluster.</p>\n "
|
||||
},
|
||||
"CacheNodeIdsToRemove": {
|
||||
"shape_name": "CacheNodeIdsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "CacheNodeId"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache node IDs that are being removed (or will be removed) from the cache\n cluster. A node ID is a numeric identifier (0001, 0002, etc.).</p>\n "
|
||||
},
|
||||
"EngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The new cache engine version that the cache cluster will run.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A group of settings that will be applied to the cache cluster in the future, or that are\n currently being applied.</p>\n "
|
||||
},
|
||||
"NotificationConfiguration": {
|
||||
"shape_name": "NotificationConfiguration",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"TopicArn": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon Resource Name (ARN) that identifies the topic.</p>\n "
|
||||
},
|
||||
"TopicStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of the topic.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Describes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).</p>\n "
|
||||
},
|
||||
"CacheSecurityGroups": {
|
||||
"shape_name": "CacheSecurityGroupMembershipList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "CacheSecurityGroupMembership",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache security group.</p>\n "
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents a cache cluster's status within a particular cache security group.</p>\n ",
|
||||
"xmlname": "CacheSecurityGroup"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache security group elements, composed of name and status sub-elements.</p>\n "
|
||||
},
|
||||
"CacheParameterGroup": {
|
||||
"shape_name": "CacheParameterGroupStatus",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group.</p>\n "
|
||||
},
|
||||
"ParameterApplyStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of parameter updates.</p>\n "
|
||||
},
|
||||
"CacheNodeIdsToReboot": {
|
||||
"shape_name": "CacheNodeIdsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "CacheNodeId"
|
||||
},
|
||||
"documentation": "\n <p>A list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The status of the cache parameter group.</p>\n "
|
||||
},
|
||||
"CacheSubnetGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache subnet group associated with the cache cluster.</p>\n "
|
||||
},
|
||||
"CacheNodes": {
|
||||
"shape_name": "CacheNodeList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "CacheNode",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.</p>\n "
|
||||
},
|
||||
"CacheNodeStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of this cache node.</p>\n "
|
||||
},
|
||||
"CacheNodeCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the cache node was created.</p>\n "
|
||||
},
|
||||
"Endpoint": {
|
||||
"shape_name": "Endpoint",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Address": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The DNS hostname of the cache node.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number that the cache engine is listening on.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The hostname and IP address for connecting to this cache node.</p>\n "
|
||||
},
|
||||
"ParameterGroupStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the parameter group applied to this cache node.</p>\n "
|
||||
},
|
||||
"SourceCacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of the primary node to which this read replica node is synchronized. If this field\n is empty, then this node is not associated with a primary cache cluster.</p>\n "
|
||||
},
|
||||
"CustomerAvailabilityZone": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Availability Zone where this node was created and now resides.</p> \n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.</p>\n ",
|
||||
"xmlname": "CacheNode"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache nodes that are members of the cache cluster.</p>\n "
|
||||
},
|
||||
"AutoMinorVersionUpgrade": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>If <code>true</code>, then minor version patches are applied automatically; if\n <code>false</code>, then automatic minor version patches are disabled.</p>\n "
|
||||
},
|
||||
"SecurityGroups": {
|
||||
"shape_name": "SecurityGroupMembershipList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "SecurityGroupMembership",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"SecurityGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier of the cache security group.</p>\n "
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents a single cache security group and its status..</p>\n "
|
||||
},
|
||||
"documentation": "\n <p>A list of VPC Security Groups associated with the cache cluster.</p>\n "
|
||||
},
|
||||
"ReplicationGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.</p>\n "
|
||||
},
|
||||
"SnapshotRetentionLimit": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set <i>SnapshotRetentionLimit</i> to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.</p>\n <p><b>Important</b><br>If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</p>\n "
|
||||
},
|
||||
"SnapshotWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.</p>\n <p>Example: <code>05:00-09:00</code></p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Contains all of the attributes of a specific cache cluster.</p>\n "
|
||||
}
|
||||
}
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidCacheClusterStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache cluster is not in the <i>available</i> state.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidCacheSecurityGroupStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The current state of the cache security group does not allow deletion.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InsufficientCacheClusterCapacityFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache node type is not available in the specified Availability Zone.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheClusterNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache cluster ID does not refer to an existing cache cluster.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "NodeQuotaForClusterExceededFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The request cannot be processed because it would exceed the allowed number of cache nodes\n in a single cache cluster.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "NodeQuotaForCustomerExceededFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The request cannot be processed because it would exceed the allowed number of cache nodes\n per customer. </p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheSecurityGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p> The requested cache security group name does not refer to an existing cache security\n group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheParameterGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p> The requested cache parameter group name does not refer to an existing cache parameter\n group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidVPCNetworkStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The VPC network is in an invalid state.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>ModifyCacheCluster</i> operation modifies the settings for a cache cluster. You\n can use this operation to change one or more cluster configuration parameters by\n specifying the parameters and the new values.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=ModifyCacheCluster\n &NumCacheNodes=5\n &CacheClusterId=simcoprod01\n &ApplyImmediately=true\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse>\n<ModifyCacheClusterResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <ModifyCacheClusterResult>\n <CacheCluster>\n <CacheParameterGroup>\n <ParameterApplyStatus>in-sync</ParameterApplyStatus>\n <CacheParameterGroupName>default.memcached1.4</CacheParameterGroupName>\n <CacheNodeIdsToReboot/>\n </CacheParameterGroup>\n <CacheClusterId>simcoprod01</CacheClusterId>\n <CacheClusterStatus>available</CacheClusterStatus>\n <ConfigurationEndpoint>\n <Port>11211</Port>\n <Address>simcoprod01.m2st2p.cfg.cache.amazonaws.com</Address>\n </ConfigurationEndpoint>\n <CacheNodeType>cache.m1.large</CacheNodeType>\n <Engine>memcached</Engine>\n <PendingModifiedValues>\n <NumCacheNodes>5</NumCacheNodes>\n </PendingModifiedValues>\n <PreferredAvailabilityZone>us-east-1b</PreferredAvailabilityZone>\n <CacheClusterCreateTime>2014-03-26T23:45:20.937Z</CacheClusterCreateTime>\n <EngineVersion>1.4.5</EngineVersion>\n <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>\n <PreferredMaintenanceWindow>fri:04:30-fri:05:00</PreferredMaintenanceWindow>\n <CacheSecurityGroups>\n <CacheSecurityGroup>\n <CacheSecurityGroupName>default</CacheSecurityGroupName>\n <Status>active</Status>\n </CacheSecurityGroup>\n </CacheSecurityGroups>\n <NumCacheNodes>3</NumCacheNodes>\n </CacheCluster>\n </ModifyCacheClusterResult>\n <ResponseMetadata>\n <RequestId>d5786c6d-b7fe-11e0-9326-b7275b9d4a6c</RequestId>\n </ResponseMetadata>\n</ModifyCacheClusterResponse></queryresponse>\n </examples>\n "
|
||||
},
|
||||
"ModifyCacheParameterGroup": {
|
||||
"name": "ModifyCacheParameterGroup",
|
||||
"input": {
|
||||
"shape_name": "ModifyCacheParameterGroupMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group to modify.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"ParameterNameValues": {
|
||||
"shape_name": "ParameterNameValueList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "ParameterNameValue",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ParameterName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the parameter.</p>\n "
|
||||
},
|
||||
"ParameterValue": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The value of the parameter.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Describes a name-value pair that is used to update the value of a parameter.</p>\n ",
|
||||
"xmlname": "ParameterNameValue"
|
||||
},
|
||||
"documentation": "\n <p>An array of parameter names and values for the parameter update. You must supply at least\n one parameter name and value; subsequent arguments are optional. A maximum of 20\n parameters may be modified per request.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>ModifyCacheParameterGroup</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CacheParameterGroupNameMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the output of one of the following operations:</p>\n <ul>\n <li>\n <i>ModifyCacheParameterGroup</i>\n </li>\n <li>\n <i>ResetCacheParameterGroup</i>\n </li>\n </ul>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "CacheParameterGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p> The requested cache parameter group name does not refer to an existing cache parameter\n group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidCacheParameterGroupStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The current state of the cache parameter group does not allow the requested action to\n occur. </p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>ModifyCacheParameterGroup</i> operation modifies the parameters of a cache\n parameter group. You can modify up to 20 parameters in a single request by submitting a\n list parameter name and value pairs.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=ModifyCacheParameterGroup\n ?ParameterNameValues.member.1.ParameterName=chunk_size_growth_factor\n &ParameterNameValues.member.1.ParameterValue=1.02\n &CacheParameterGroupName=mycacheparametergroup\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse>\n<ModifyCacheParameterGroupResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <ModifyCacheParameterGroupResult>\n <CacheParameterGroupName>mycacheparametergroup</CacheParameterGroupName>\n </ModifyCacheParameterGroupResult>\n <ResponseMetadata>\n <RequestId>fcedeef2-b7ff-11e0-9326-b7275b9d4a6c</RequestId>\n </ResponseMetadata>\n</ModifyCacheParameterGroupResponse>\n </queryresponse>\n </examples>\n "
|
||||
},
|
||||
"ModifyCacheSubnetGroup": {
|
||||
"name": "ModifyCacheSubnetGroup",
|
||||
"input": {
|
||||
"shape_name": "ModifyCacheSubnetGroupMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSubnetGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name for the cache subnet group. This value is stored as a lowercase string.</p>\n <p>Constraints: Must contain no more than 255 alphanumeric characters or hyphens.</p>\n <p>Example: <code>mysubnetgroup</code></p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"CacheSubnetGroupDescription": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A description for the cache subnet group.</p>\n "
|
||||
},
|
||||
"SubnetIds": {
|
||||
"shape_name": "SubnetIdentifierList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "SubnetIdentifier"
|
||||
},
|
||||
"documentation": "\n <p>The EC2 subnet IDs for the cache subnet group.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>ModifyCacheSubnetGroup</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CacheSubnetGroupWrapper",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSubnetGroup": {
|
||||
"shape_name": "CacheSubnetGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSubnetGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache subnet group.</p>\n "
|
||||
},
|
||||
"CacheSubnetGroupDescription": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The description of the cache subnet group.</p>\n "
|
||||
},
|
||||
"VpcId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.</p>\n "
|
||||
},
|
||||
"Subnets": {
|
||||
"shape_name": "SubnetList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Subnet",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"SubnetIdentifier": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The unique identifier for the subnet</p>\n "
|
||||
},
|
||||
"SubnetAvailabilityZone": {
|
||||
"shape_name": "AvailabilityZone",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Availability Zone.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>The Availability Zone associated with the subnet</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the subnet associated with a cache cluster. This parameter refers to subnets\n defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.</p>\n ",
|
||||
"xmlname": "Subnet"
|
||||
},
|
||||
"documentation": "\n <p>A list of subnets associated with the cache subnet group.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents the output of one of the following operations:</p>\n <ul>\n <li>\n <i>CreateCacheSubnetGroup</i>\n </li>\n <li>\n <i>ModifyCacheSubnetGroup</i>\n </li>\n </ul>\n "
|
||||
}
|
||||
}
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "CacheSubnetGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache subnet group name does not refer to an existing cache subnet\n group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheSubnetQuotaExceededFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The request cannot be processed because it would exceed the allowed number of subnets in\n a cache subnet group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "SubnetInUse",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested subnet is being used by another cache subnet group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidSubnet",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>An invalid subnet identifier was specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>ModifyCacheSubnetGroup</i> operation modifies an existing cache subnet group.</p>\n <examples>\n <queryrequest>https://elasticache.amazonaws.com/\n ?Action=ModifyCacheSubnetGroup\n &CacheSubnetGroupName=myCachesubnetgroup\n &CacheSubnetGroupDescription=My%20modified%20CacheSubnetGroup\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse><ModifyCacheSubnetGroupResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <ModifyCacheSubnetGroupResult>\n <CacheSubnetGroup>\n <VpcId>990524496922</VpcId>\n <CacheSubnetGroupDescription>My modified CacheSubnetGroup</CacheSubnetGroupDescription>\n <CacheSubnetGroupName>myCachesubnetgroup</CacheSubnetGroupName>\n <Subnets>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-7c5b4115</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1c</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-7b5b4112</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1b</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n <Subnet>\n <SubnetStatus>Active</SubnetStatus>\n <SubnetIdentifier>subnet-3ea6bd57</SubnetIdentifier>\n <SubnetAvailabilityZone>\n <Name>us-east-1d</Name>\n </SubnetAvailabilityZone>\n </Subnet>\n </Subnets>\n </CacheSubnetGroup>\n </ModifyCacheSubnetGroupResult>\n <ResponseMetadata>\n <RequestId>ed662948-a57b-11df-9e38-7ffab86c801f</RequestId>\n </ResponseMetadata>\n </ModifyCacheSubnetGroupResponse></queryresponse>\n </examples>\n "
|
||||
},
|
||||
"ModifyReplicationGroup": {
|
||||
"name": "ModifyReplicationGroup",
|
||||
"input": {
|
||||
"shape_name": "ModifyReplicationGroupMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ReplicationGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier of the replication group to modify.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"ReplicationGroupDescription": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A description for the replication group. Maximum length is 255 characters.</p>\n "
|
||||
},
|
||||
"CacheSecurityGroupNames": {
|
||||
"shape_name": "CacheSecurityGroupNameList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "CacheSecurityGroupName"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache security group names to authorize for the clusters in this replication\n group. This change is asynchronously applied as soon as possible.</p>\n <p>This parameter can be used only with replication groups containing cache clusters running\n outside of an Amazon Virtual Private Cloud (VPC).</p>\n <p>Constraints: Must contain no more than 255 alphanumeric characters. Must not be\n \"Default\".</p>\n "
|
||||
},
|
||||
"SecurityGroupIds": {
|
||||
"shape_name": "SecurityGroupIdsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "SecurityGroupId"
|
||||
},
|
||||
"documentation": "\n <p>Specifies the VPC Security Groups associated with the cache clusters in the replication\n group.</p>\n <p>This parameter can be used only with replication groups containing cache clusters running\n in an Amazon Virtual Private Cloud (VPC).</p>\n "
|
||||
},
|
||||
"PreferredMaintenanceWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The weekly time range (in UTC) during which replication group system maintenance can\n occur. Note that system maintenance may result in an outage. This change is made\n immediately. If you are moving this window to the current time, there must be at least\n 120 minutes between the current time and end of the window to ensure that pending\n changes are applied.</p>\n "
|
||||
},
|
||||
"NotificationTopicArn": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.</p>\n <note>The Amazon SNS topic owner must be same as the replication group owner. </note>\n "
|
||||
},
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group to apply to all of the cache nodes in this\n replication group. This change is asynchronously applied as soon as possible for\n parameters when the <i>ApplyImmediately</i> parameter is specified as <i>true</i> for\n this request.</p>\n "
|
||||
},
|
||||
"NotificationTopicStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the Amazon SNS notification topic for the replication group. Notifications\n are sent only if the status is <i>active</i>.</p>\n <p>Valid values: <code>active</code> | <code>inactive</code></p>\n "
|
||||
},
|
||||
"ApplyImmediately": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>If <code>true</code>, this parameter causes the modifications in this request and any\n pending modifications to be applied, asynchronously and as soon as possible, regardless\n of the <i>PreferredMaintenanceWindow</i> setting for the replication group.</p>\n <p>If <code>false</code>, then changes to the nodes in the replication group are applied on\n the next maintenance reboot, or the next failure reboot, whichever occurs first.</p>\n <p>Valid values: <code>true</code> | <code>false</code></p>\n <p>Default: <code>false</code></p>\n "
|
||||
},
|
||||
"EngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The upgraded version of the cache engine to be run on the nodes in the replication\n group..</p>\n "
|
||||
},
|
||||
"AutoMinorVersionUpgrade": {
|
||||
"shape_name": "BooleanOptional",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Determines whether minor engine upgrades will be applied automatically to all of the\n cache nodes in the replication group during the maintenance window. A value of\n <code>true</code> allows these upgrades to occur; <code>false</code> disables\n automatic upgrades.</p>\n "
|
||||
},
|
||||
"PrimaryClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>If this parameter is specified, ElastiCache will promote each of the nodes in the specified\n cache cluster to the primary role. The nodes of all other clusters in the replication\n group will be read replicas.</p>\n "
|
||||
},
|
||||
"SnapshotRetentionLimit": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set <i>SnapshotRetentionLimit</i> to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.</p>\n <p><b>Important</b><br>If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</p>\n "
|
||||
},
|
||||
"SnapshotWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n the cache cluster specified by <i>SnapshottingClusterId</i>.</p>\n <p>Example: <code>05:00-09:00</code></p>\n <p>If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.</p>\n \n "
|
||||
},
|
||||
"SnapshottingClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache cluster ID that will be used as the daily snapshot source for the replication\n group.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>ModifyReplicationGroups</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ReplicationGroupWrapper",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ReplicationGroup": {
|
||||
"shape_name": "ReplicationGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ReplicationGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier for the replication group.</p>\n "
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The description of the replication group.</p>\n "
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of this replication group - <i>creating</i>, <i>available</i>, etc.</p>\n "
|
||||
},
|
||||
"PendingModifiedValues": {
|
||||
"shape_name": "ReplicationGroupPendingModifiedValues",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"PrimaryClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The primary cluster ID which will be applied immediately (if\n <code>--apply-immediately</code> was specified), or during the next maintenance\n window.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A group of settings to be applied to the replication group, either immediately or during\n the next maintenance window.</p>\n "
|
||||
},
|
||||
"MemberClusters": {
|
||||
"shape_name": "ClusterIdList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "ClusterId"
|
||||
},
|
||||
"documentation": "\n <p>The names of all the cache clusters that are part of this replication group.</p>\n "
|
||||
},
|
||||
"NodeGroups": {
|
||||
"shape_name": "NodeGroupList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "NodeGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"NodeGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier for the node group. A replication group contains only one node group;\n therefore, the node group ID is 0001.</p>\n "
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of this replication group - <i>creating</i>, <i>available</i>, etc.</p>\n "
|
||||
},
|
||||
"PrimaryEndpoint": {
|
||||
"shape_name": "Endpoint",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Address": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The DNS hostname of the cache node.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number that the cache engine is listening on.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the information required for client programs to connect to a cache node.</p>\n "
|
||||
},
|
||||
"NodeGroupMembers": {
|
||||
"shape_name": "NodeGroupMemberList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "NodeGroupMember",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of the cache cluster to which the node belongs.</p>\n "
|
||||
},
|
||||
"CacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of the node within its cache cluster. A node ID is a numeric identifier (0001,\n 0002, etc.).</p>\n "
|
||||
},
|
||||
"ReadEndpoint": {
|
||||
"shape_name": "Endpoint",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Address": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The DNS hostname of the cache node.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number that the cache engine is listening on.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the information required for client programs to connect to a cache node.</p>\n "
|
||||
},
|
||||
"PreferredAvailabilityZone": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Availability Zone in which the node is located.</p>\n "
|
||||
},
|
||||
"CurrentRole": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The role that is currently assigned to the node - <i>primary</i> or <i>replica</i>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents a single node within a node group.</p>\n ",
|
||||
"xmlname": "NodeGroupMember"
|
||||
},
|
||||
"documentation": "\n <p>A list containing information about individual nodes within the node group.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents a collection of cache nodes in a replication group.</p>\n ",
|
||||
"xmlname": "NodeGroup"
|
||||
},
|
||||
"documentation": "\n <p>A single element list with information about the nodes in the replication group.</p>\n "
|
||||
},
|
||||
"SnapshottingClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache cluster ID that is used as the daily snapshot source for the replication\n group.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Contains all of the attributes of a specific replication group.</p>\n "
|
||||
}
|
||||
}
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "ReplicationGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The specified replication group does not exist.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidReplicationGroupStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested replication group is not in the <i>available</i> state.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidCacheClusterStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache cluster is not in the <i>available</i> state.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidCacheSecurityGroupStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The current state of the cache security group does not allow deletion.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheClusterNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache cluster ID does not refer to an existing cache cluster.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheSecurityGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p> The requested cache security group name does not refer to an existing cache security\n group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheParameterGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p> The requested cache parameter group name does not refer to an existing cache parameter\n group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidVPCNetworkStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The VPC network is in an invalid state.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>ModifyReplicationGroup</i> operation modifies the settings for a replication\n group.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=ModifyReplicationGroup\n &ApplyImmediately=false\n &ReplicationGroupId=my-repgroup\n &PrimaryClusterId=my-replica-1\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse><ModifyReplicationGroupResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\"> \n <ModifyReplicationGroupResult> \n <ReplicationGroup> \n <SnapshottingClusterId>my-redis-primary</SnapshottingClusterId> \n <MemberClusters> \n <ClusterId>my-redis-primary</ClusterId> \n <ClusterId>my-replica-1</ClusterId> \n </MemberClusters> \n <NodeGroups> \n <NodeGroup> \n <NodeGroupId>0001</NodeGroupId> \n <PrimaryEndpoint> \n <Port>6379</Port> \n <Address>my-repgroup.q68zge.ng.0001.use1devo.elmo-dev.amazonaws.com</Address> \n </PrimaryEndpoint> \n <Status>available</Status> \n <NodeGroupMembers> \n <NodeGroupMember> \n <CacheClusterId>my-redis-primary</CacheClusterId> \n <ReadEndpoint> \n <Port>6379</Port> \n <Address>my-redis-primary.q68zge.0001.use1devo.elmo-dev.amazonaws.com</Address> \n </ReadEndpoint> \n <PreferredAvailabilityZone>us-east-1d</PreferredAvailabilityZone> \n <CacheNodeId>0001</CacheNodeId> \n <CurrentRole>primary</CurrentRole> \n </NodeGroupMember> \n <NodeGroupMember> \n <CacheClusterId>my-replica-1</CacheClusterId> \n <ReadEndpoint> \n <Port>6379</Port> \n <Address>my-replica-1.q68zge.0001.use1devo.elmo-dev.amazonaws.com</Address> \n </ReadEndpoint> \n <PreferredAvailabilityZone>us-east-1e</PreferredAvailabilityZone> \n <CacheNodeId>0001</CacheNodeId> \n <CurrentRole>replica</CurrentRole> \n </NodeGroupMember> \n </NodeGroupMembers> \n </NodeGroup> \n </NodeGroups> \n <ReplicationGroupId>my-repgroup</ReplicationGroupId> \n <Status>available</Status> \n <PendingModifiedValues> \n <PrimaryClusterId>my-replica-1</PrimaryClusterId> \n </PendingModifiedValues> \n <Description>My replication group</Description> \n </ReplicationGroup> \n </ModifyReplicationGroupResult> \n <ResponseMetadata> \n <RequestId>6fd0aad6-b9d7-11e3-8a16-7978bb24ffdf</RequestId> \n </ResponseMetadata> \n</ModifyReplicationGroupResponse>\n</queryresponse>\n </examples>\n "
|
||||
},
|
||||
"PurchaseReservedCacheNodesOffering": {
|
||||
"name": "PurchaseReservedCacheNodesOffering",
|
||||
"input": {
|
||||
"shape_name": "PurchaseReservedCacheNodesOfferingMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ReservedCacheNodesOfferingId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of the reserved cache node offering to purchase.</p>\n <p>Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"ReservedCacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A customer-specified identifier to track this reservation.</p>\n <p>Example: myreservationID</p>\n "
|
||||
},
|
||||
"CacheNodeCount": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of cache node instances to reserve.</p>\n <p>Default: <code>1</code></p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>PurchaseReservedCacheNodesOffering</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ReservedCacheNodeWrapper",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ReservedCacheNode": {
|
||||
"shape_name": "ReservedCacheNode",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ReservedCacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The unique identifier for the reservation.</p>\n "
|
||||
},
|
||||
"ReservedCacheNodesOfferingId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The offering identifier.</p>\n "
|
||||
},
|
||||
"CacheNodeType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache node type for the reserved cache nodes.</p>\n "
|
||||
},
|
||||
"StartTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The time the reservation started.</p>\n "
|
||||
},
|
||||
"Duration": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The duration of the reservation in seconds.</p>\n "
|
||||
},
|
||||
"FixedPrice": {
|
||||
"shape_name": "Double",
|
||||
"type": "double",
|
||||
"documentation": "\n <p>The fixed price charged for this reserved cache node.</p>\n "
|
||||
},
|
||||
"UsagePrice": {
|
||||
"shape_name": "Double",
|
||||
"type": "double",
|
||||
"documentation": "\n <p>The hourly price charged for this reserved cache node.</p>\n "
|
||||
},
|
||||
"CacheNodeCount": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of cache nodes that have been reserved.</p>\n "
|
||||
},
|
||||
"ProductDescription": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The description of the reserved cache node.</p>\n "
|
||||
},
|
||||
"OfferingType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The offering type of this reserved cache node.</p>\n "
|
||||
},
|
||||
"State": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The state of the reserved cache node.</p>\n "
|
||||
},
|
||||
"RecurringCharges": {
|
||||
"shape_name": "RecurringChargeList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "RecurringCharge",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"RecurringChargeAmount": {
|
||||
"shape_name": "Double",
|
||||
"type": "double",
|
||||
"documentation": "\n <p>The monetary amount of the recurring charge.</p>\n "
|
||||
},
|
||||
"RecurringChargeFrequency": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The frequency of the recurring charge.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Contains the specific price and frequency of a recurring charges for a reserved cache\n node, or for a reserved cache node offering.</p>\n ",
|
||||
"xmlname": "RecurringCharge"
|
||||
},
|
||||
"documentation": "\n <p>The recurring price charged to run this reserved cache node.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents the output of a <i>PurchaseReservedCacheNodesOffering</i> operation.</p>\n "
|
||||
}
|
||||
}
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "ReservedCacheNodesOfferingNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache node offering does not exist.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "ReservedCacheNodeAlreadyExistsFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>You already have a reservation with the given identifier.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "ReservedCacheNodeQuotaExceededFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The request cannot be processed because it would exceed the user's cache node quota.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>PurchaseReservedCacheNodesOffering</i> operation allows you to purchase a reserved\n cache node offering.</p>\n <examples>\n <queryrequest>https://elasticache.amazonaws.com/\n ?Action=PurchaseReservedCacheNodesOffering\n &ReservedCacheNodeId=myreservationID\n &ReservedCacheNodesOfferingId=438012d3-4052-4cc7-b2e3-8d3372e0e706\n &CacheNodeCount=1\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse><PurchaseReservedCacheNodesOfferingResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <PurchaseReservedCacheNodesOfferingResult>\n <ReservedCacheNode>\n <OfferingType>Medium Utilization</OfferingType>\n <RecurringCharges/>\n <ProductDescription>memcached</ProductDescription>\n <ReservedCacheNodesOfferingId> 438012d3-4052-4cc7-b2e3-8d3372e0e706</ReservedCacheNodesOfferingId>\n <State>payment-pending</State>\n <ReservedCacheNodeId>myreservationID</ReservedCacheNodeId>\n <CacheNodeCount>10</CacheNodeCount>\n <StartTime>2014-03-18T23:24:56.577Z</StartTime>\n <Duration>31536000</Duration>\n <FixedPrice>123.0</FixedPrice>\n <UsagePrice>0.123</UsagePrice>\n <CacheNodeType>cache.m1.small</CacheNodeType>\n </ReservedCacheNode>\n </PurchaseReservedCacheNodesOfferingResult>\n <ResponseMetadata>\n <RequestId>7f099901-29cf-11e1-bd06-6fe008f046c3</RequestId>\n </ResponseMetadata>\n</PurchaseReservedCacheNodesOfferingResponse>\n</queryresponse>\n </examples>\n "
|
||||
},
|
||||
"RebootCacheCluster": {
|
||||
"name": "RebootCacheCluster",
|
||||
"input": {
|
||||
"shape_name": "RebootCacheClusterMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache cluster identifier. This parameter is stored as a lowercase string.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"CacheNodeIdsToReboot": {
|
||||
"shape_name": "CacheNodeIdsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "CacheNodeId"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache node IDs to reboot. A node ID is a numeric identifier (0001,\n 0002, etc.). To reboot an entire cache cluster, specify all of the cache node\n IDs.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>RebootCacheCluster</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CacheClusterWrapper",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheCluster": {
|
||||
"shape_name": "CacheCluster",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheClusterId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The user-supplied identifier of the cache cluster. This is a unique key that identifies a\n cache cluster.</p>\n "
|
||||
},
|
||||
"ConfigurationEndpoint": {
|
||||
"shape_name": "Endpoint",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Address": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The DNS hostname of the cache node.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number that the cache engine is listening on.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the information required for client programs to connect to a cache node.</p>\n "
|
||||
},
|
||||
"ClientDownloadLandingPage": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The URL of the web page where you can download the latest ElastiCache client library.</p>\n "
|
||||
},
|
||||
"CacheNodeType": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the compute and memory capacity node type for the cache cluster.</p>\n "
|
||||
},
|
||||
"Engine": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache engine (<i>memcached</i> or <i>redis</i>) to be used for this cache\n cluster.</p>\n "
|
||||
},
|
||||
"EngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The version of the cache engine version that is used in this cache cluster.</p>\n "
|
||||
},
|
||||
"CacheClusterStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of this cache cluster - <i>creating</i>, <i>available</i>, etc.</p>\n "
|
||||
},
|
||||
"NumCacheNodes": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of cache nodes in the cache cluster.</p>\n "
|
||||
},
|
||||
"PreferredAvailabilityZone": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Availability Zone in which the cache cluster is located or \n \"Multiple\" if the cache nodes are located in different Availability Zones.</p>\n "
|
||||
},
|
||||
"CacheClusterCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the cache cluster was created.</p>\n "
|
||||
},
|
||||
"PreferredMaintenanceWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The time range (in UTC) during which weekly system maintenance can occur.</p>\n "
|
||||
},
|
||||
"PendingModifiedValues": {
|
||||
"shape_name": "PendingModifiedValues",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"NumCacheNodes": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The new number of cache nodes for the cache cluster.</p>\n "
|
||||
},
|
||||
"CacheNodeIdsToRemove": {
|
||||
"shape_name": "CacheNodeIdsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "CacheNodeId"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache node IDs that are being removed (or will be removed) from the cache\n cluster. A node ID is a numeric identifier (0001, 0002, etc.).</p>\n "
|
||||
},
|
||||
"EngineVersion": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The new cache engine version that the cache cluster will run.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A group of settings that will be applied to the cache cluster in the future, or that are\n currently being applied.</p>\n "
|
||||
},
|
||||
"NotificationConfiguration": {
|
||||
"shape_name": "NotificationConfiguration",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"TopicArn": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Amazon Resource Name (ARN) that identifies the topic.</p>\n "
|
||||
},
|
||||
"TopicStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of the topic.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Describes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).</p>\n "
|
||||
},
|
||||
"CacheSecurityGroups": {
|
||||
"shape_name": "CacheSecurityGroupMembershipList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "CacheSecurityGroupMembership",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache security group.</p>\n "
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents a cache cluster's status within a particular cache security group.</p>\n ",
|
||||
"xmlname": "CacheSecurityGroup"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache security group elements, composed of name and status sub-elements.</p>\n "
|
||||
},
|
||||
"CacheParameterGroup": {
|
||||
"shape_name": "CacheParameterGroupStatus",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group.</p>\n "
|
||||
},
|
||||
"ParameterApplyStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of parameter updates.</p>\n "
|
||||
},
|
||||
"CacheNodeIdsToReboot": {
|
||||
"shape_name": "CacheNodeIdsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": null,
|
||||
"xmlname": "CacheNodeId"
|
||||
},
|
||||
"documentation": "\n <p>A list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The status of the cache parameter group.</p>\n "
|
||||
},
|
||||
"CacheSubnetGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache subnet group associated with the cache cluster.</p>\n "
|
||||
},
|
||||
"CacheNodes": {
|
||||
"shape_name": "CacheNodeList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "CacheNode",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.</p>\n "
|
||||
},
|
||||
"CacheNodeStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The current state of this cache node.</p>\n "
|
||||
},
|
||||
"CacheNodeCreateTime": {
|
||||
"shape_name": "TStamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date and time when the cache node was created.</p>\n "
|
||||
},
|
||||
"Endpoint": {
|
||||
"shape_name": "Endpoint",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Address": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The DNS hostname of the cache node.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Integer",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The port number that the cache engine is listening on.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The hostname and IP address for connecting to this cache node.</p>\n "
|
||||
},
|
||||
"ParameterGroupStatus": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the parameter group applied to this cache node.</p>\n "
|
||||
},
|
||||
"SourceCacheNodeId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of the primary node to which this read replica node is synchronized. If this field\n is empty, then this node is not associated with a primary cache cluster.</p>\n "
|
||||
},
|
||||
"CustomerAvailabilityZone": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The Availability Zone where this node was created and now resides.</p> \n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.</p>\n ",
|
||||
"xmlname": "CacheNode"
|
||||
},
|
||||
"documentation": "\n <p>A list of cache nodes that are members of the cache cluster.</p>\n "
|
||||
},
|
||||
"AutoMinorVersionUpgrade": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>If <code>true</code>, then minor version patches are applied automatically; if\n <code>false</code>, then automatic minor version patches are disabled.</p>\n "
|
||||
},
|
||||
"SecurityGroups": {
|
||||
"shape_name": "SecurityGroupMembershipList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "SecurityGroupMembership",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"SecurityGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The identifier of the cache security group.</p>\n "
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents a single cache security group and its status..</p>\n "
|
||||
},
|
||||
"documentation": "\n <p>A list of VPC Security Groups associated with the cache cluster.</p>\n "
|
||||
},
|
||||
"ReplicationGroupId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.</p>\n "
|
||||
},
|
||||
"SnapshotRetentionLimit": {
|
||||
"shape_name": "IntegerOptional",
|
||||
"type": "integer",
|
||||
"documentation": "\n <p>The number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set <i>SnapshotRetentionLimit</i> to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.</p>\n <p><b>Important</b><br>If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</p>\n "
|
||||
},
|
||||
"SnapshotWindow": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.</p>\n <p>Example: <code>05:00-09:00</code></p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Contains all of the attributes of a specific cache cluster.</p>\n "
|
||||
}
|
||||
}
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidCacheClusterStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache cluster is not in the <i>available</i> state.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheClusterNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The requested cache cluster ID does not refer to an existing cache cluster.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>RebootCacheCluster</i> operation reboots some, or all, of the cache nodes\n within a provisioned cache cluster. This API will apply any modified cache parameter\n groups to the cache cluster. The reboot action takes place as soon as possible, and\n results in a momentary outage to the cache cluster. During the reboot, the cache cluster\n status is set to REBOOTING.</p>\n <p>The reboot causes the contents of the cache (for each cache node being rebooted)\n to be lost.</p>\n <p>When the reboot is complete, a cache cluster event is created.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=RebootCacheCluster\n &CacheClusterId=mycache\n &CacheNodeIdsToReboot.member.1=0001\n &CacheNodeIdsToReboot.member.2=0002\n &CacheNodeIdsToReboot.member.3=0003\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse><RebootCacheClusterResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\"> \n <RebootCacheClusterResult> \n <CacheCluster> \n <CacheClusterStatus>rebooting cache cluster nodes</CacheClusterStatus> \n <CacheParameterGroup> \n <CacheParameterGroupName>default.memcached1.4</CacheParameterGroupName> \n <ParameterApplyStatus>in-sync</ParameterApplyStatus> \n <CacheNodeIdsToReboot /> \n </CacheParameterGroup> \n <CacheClusterId>mycache</CacheClusterId> \n <ConfigurationEndpoint> \n <Port>11211</Port> \n <Address>mycache.q68zge.cfg.use1devo.elmo-dev.amazonaws.com</Address> \n </ConfigurationEndpoint> \n <CacheNodeType>cache.m1.small</CacheNodeType> \n <Engine>memcached</Engine> \n <PendingModifiedValues /> \n <PreferredAvailabilityZone>us-east-1b</PreferredAvailabilityZone> \n <CacheClusterCreateTime>2014-04-01T19:04:12.812Z</CacheClusterCreateTime> \n <EngineVersion>1.4.17</EngineVersion> \n <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade> \n <PreferredMaintenanceWindow>wed:09:00-wed:10:00</PreferredMaintenanceWindow> \n <ClientDownloadLandingPage>https://console.aws.amazon.com/elasticache/home#client-download:</ClientDownloadLandingPage> \n <CacheSecurityGroups> \n <CacheSecurityGroup> \n <CacheSecurityGroupName>default</CacheSecurityGroupName> \n <Status>active</Status> \n </CacheSecurityGroup> \n </CacheSecurityGroups> \n <NumCacheNodes>3</NumCacheNodes> \n </CacheCluster> \n </RebootCacheClusterResult> \n <ResponseMetadata> \n <RequestId>cf7e6fc4-b9d1-11e3-8a16-7978bb24ffdf</RequestId> \n </ResponseMetadata> \n</RebootCacheClusterResponse>\n</queryresponse>\n </examples>\n "
|
||||
},
|
||||
"ResetCacheParameterGroup": {
|
||||
"name": "ResetCacheParameterGroup",
|
||||
"input": {
|
||||
"shape_name": "ResetCacheParameterGroupMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group to reset.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"ResetAllParameters": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>If <i>true</i>, all parameters in the cache parameter group will be reset to default\n values. If <i>false</i>, no such action occurs.</p>\n <p>Valid values: <code>true</code> | <code>false</code></p>\n "
|
||||
},
|
||||
"ParameterNameValues": {
|
||||
"shape_name": "ParameterNameValueList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "ParameterNameValue",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ParameterName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the parameter.</p>\n "
|
||||
},
|
||||
"ParameterValue": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The value of the parameter.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Describes a name-value pair that is used to update the value of a parameter.</p>\n ",
|
||||
"xmlname": "ParameterNameValue"
|
||||
},
|
||||
"documentation": "\n <p>An array of parameter names to be reset. If you are not resetting the entire cache\n parameter group, you must specify at least one parameter name.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>ResetCacheParameterGroup</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CacheParameterGroupNameMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheParameterGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache parameter group.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the output of one of the following operations:</p>\n <ul>\n <li>\n <i>ModifyCacheParameterGroup</i>\n </li>\n <li>\n <i>ResetCacheParameterGroup</i>\n </li>\n </ul>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidCacheParameterGroupStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The current state of the cache parameter group does not allow the requested action to\n occur. </p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CacheParameterGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p> The requested cache parameter group name does not refer to an existing cache parameter\n group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>ResetCacheParameterGroup</i> operation modifies the parameters of a cache\n parameter group to the engine or system default value. You can reset specific parameters\n by submitting a list of parameter names. To reset the entire cache parameter group,\n specify the <i>ResetAllParameters</i> and <i>CacheParameterGroupName</i> parameters.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=ResetCacheParameterGroup\n &ResetAllParameters=true\n &CacheParameterGroupName=mycacheparametergroup1\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse><ResetCacheParameterGroupResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\"> \n <ResetCacheParameterGroupResult> \n <CacheParameterGroupName>mycacheparametergroup1</CacheParameterGroupName> \n </ResetCacheParameterGroupResult> \n <ResponseMetadata> \n <RequestId>cb7cc855-b9d2-11e3-8a16-7978bb24ffdf</RequestId> \n </ResponseMetadata> \n</ResetCacheParameterGroupResponse>\n</queryresponse>\n </examples>\n "
|
||||
},
|
||||
"RevokeCacheSecurityGroupIngress": {
|
||||
"name": "RevokeCacheSecurityGroupIngress",
|
||||
"input": {
|
||||
"shape_name": "RevokeCacheSecurityGroupIngressMessage",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache security group to revoke ingress from.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"EC2SecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Amazon EC2 security group to revoke access from.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"EC2SecurityGroupOwnerId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The AWS account number of the Amazon EC2 security group owner. Note that this is not the\n same thing as an AWS access key ID - you must provide a valid AWS account number for\n this parameter.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents the input of a <i>RevokeCacheSecurityGroupIngress</i> operation.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CacheSecurityGroupWrapper",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CacheSecurityGroup": {
|
||||
"shape_name": "CacheSecurityGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"OwnerId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The AWS account ID of the cache security group owner.</p>\n "
|
||||
},
|
||||
"CacheSecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the cache security group.</p>\n "
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The description of the cache security group.</p>\n "
|
||||
},
|
||||
"EC2SecurityGroups": {
|
||||
"shape_name": "EC2SecurityGroupList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "EC2SecurityGroup",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Status": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The status of the Amazon EC2 security group.</p>\n "
|
||||
},
|
||||
"EC2SecurityGroupName": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the Amazon EC2 security group.</p>\n "
|
||||
},
|
||||
"EC2SecurityGroupOwnerId": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The AWS account ID of the Amazon EC2 security group owner.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Provides ownership and status information for an Amazon EC2 security group.</p>\n ",
|
||||
"xmlname": "EC2SecurityGroup"
|
||||
},
|
||||
"documentation": "\n <p>A list of Amazon EC2 security groups that are associated with this cache security\n group.</p>\n "
|
||||
}
|
||||
},
|
||||
"wrapper": true,
|
||||
"documentation": "\n <p>Represents the output of one of the following operations:</p>\n <ul>\n <li>\n <i>AuthorizeCacheSecurityGroupIngress</i>\n </li>\n <li>\n <i>CreateCacheSecurityGroup</i>\n </li>\n <li>\n <i>RevokeCacheSecurityGroupIngress</i>\n </li>\n </ul>\n "
|
||||
}
|
||||
}
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "CacheSecurityGroupNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p> The requested cache security group name does not refer to an existing cache security\n group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "AuthorizationNotFoundFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The specified Amazon EC2 security group is not authorized for the specified cache\n security group.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidCacheSecurityGroupStateFault",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>The current state of the cache security group does not allow deletion.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterValueException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A parameter value is invalid.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The value for a parameter is invalid.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidParameterCombinationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "AwsQueryErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Two or more parameters that must not be used together were used together.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Two or more incompatible parameters were specified.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>The <i>RevokeCacheSecurityGroupIngress</i> operation revokes ingress from a cache\n security group. Use this operation to disallow access from an Amazon EC2 security group\n that had been previously authorized.</p>\n <examples>\n <queryrequest>https://elasticache.us-east-1.amazonaws.com/\n ?Action=RevokeCacheSecurityGroupIngress\n &EC2SecurityGroupName=default\n &CacheSecurityGroupName=mygroup\n &EC2SecurityGroupOwnerId=1234-5678-1234\n &Version=2014-03-24\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20140401T192317Z\n &X-Amz-Credential=<credential></queryrequest>\n <queryresponse>\n<RevokeCacheSecurityGroupIngressResponse xmlns=\"http://elasticache.amazonaws.com/doc/2014-03-24/\">\n <RevokeCacheSecurityGroupIngressResult>\n <CacheSecurityGroup>\n <EC2SecurityGroups>\n <EC2SecurityGroup>\n <Status>revoking</Status>\n <EC2SecurityGroupName>default</EC2SecurityGroupName>\n <EC2SecurityGroupOwnerId>123456781234</EC2SecurityGroupOwnerId>\n </EC2SecurityGroup>\n </EC2SecurityGroups>\n <CacheSecurityGroupName>mygroup</CacheSecurityGroupName>\n <OwnerId>123456789012</OwnerId>\n <Description>My security group</Description>\n </CacheSecurityGroup>\n </RevokeCacheSecurityGroupIngressResult>\n <ResponseMetadata>\n <RequestId>02ae3699-3650-11e0-a564-8f11342c56b0</RequestId>\n </ResponseMetadata>\n</RevokeCacheSecurityGroupIngressResponse>\n </queryresponse>\n </examples>\n "
|
||||
}
|
||||
},
|
||||
"pagination": {
|
||||
"DescribeCacheClusters": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "CacheClusters",
|
||||
"py_input_token": "marker"
|
||||
},
|
||||
"DescribeCacheEngineVersions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "CacheEngineVersions",
|
||||
"py_input_token": "marker"
|
||||
},
|
||||
"DescribeCacheParameterGroups": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "CacheParameterGroups",
|
||||
"py_input_token": "marker"
|
||||
},
|
||||
"DescribeCacheParameters": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "Parameters",
|
||||
"non_aggregate_keys": [
|
||||
"CacheNodeTypeSpecificParameters"
|
||||
],
|
||||
"py_input_token": "marker"
|
||||
},
|
||||
"DescribeCacheSecurityGroups": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "CacheSecurityGroups",
|
||||
"py_input_token": "marker"
|
||||
},
|
||||
"DescribeCacheSubnetGroups": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "CacheSubnetGroups",
|
||||
"py_input_token": "marker"
|
||||
},
|
||||
"DescribeEngineDefaultParameters": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "EngineDefaults.Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "EngineDefaults.Parameters",
|
||||
"py_input_token": "marker"
|
||||
},
|
||||
"DescribeEvents": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "Events",
|
||||
"py_input_token": "marker"
|
||||
},
|
||||
"DescribeReservedCacheNodes": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "ReservedCacheNodes",
|
||||
"py_input_token": "marker"
|
||||
},
|
||||
"DescribeReservedCacheNodesOfferings": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "ReservedCacheNodesOfferings",
|
||||
"py_input_token": "marker"
|
||||
},
|
||||
"DescribeReplicationGroups": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "ReplicationGroups",
|
||||
"py_input_token": "marker"
|
||||
}
|
||||
},
|
||||
"retry": {
|
||||
"__default__": {
|
||||
"max_attempts": 5,
|
||||
"delay": {
|
||||
"type": "exponential",
|
||||
"base": "rand",
|
||||
"growth_factor": 2
|
||||
},
|
||||
"policies": {
|
||||
"general_socket_errors": {
|
||||
"applies_when": {
|
||||
"socket_errors": [
|
||||
"GENERAL_CONNECTION_ERROR"
|
||||
]
|
||||
}
|
||||
},
|
||||
"general_server_error": {
|
||||
"applies_when": {
|
||||
"response": {
|
||||
"http_status_code": 500
|
||||
}
|
||||
}
|
||||
},
|
||||
"service_unavailable": {
|
||||
"applies_when": {
|
||||
"response": {
|
||||
"http_status_code": 503
|
||||
}
|
||||
}
|
||||
},
|
||||
"limit_exceeded": {
|
||||
"applies_when": {
|
||||
"response": {
|
||||
"http_status_code": 509
|
||||
}
|
||||
}
|
||||
},
|
||||
"throttling": {
|
||||
"applies_when": {
|
||||
"response": {
|
||||
"service_error_code": "Throttling",
|
||||
"http_status_code": 400
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -9,7 +9,7 @@
|
|||
"timestamp_format": "unixTimestamp",
|
||||
"endpoint_prefix": "elasticmapreduce",
|
||||
"xmlnamespace": "http://elasticmapreduce.amazonaws.com/doc/2009-03-31",
|
||||
"documentation": "\n <p> This is the <i>Amazon Elastic MapReduce API Reference</i>. This guide provides descriptions and\n samples of the Amazon Elastic MapReduce APIs.</p>\n\n <p>Amazon Elastic MapReduce (Amazon EMR) is a web service that makes it easy to process large amounts of\n data efficiently. Amazon EMR uses Hadoop processing combined with several AWS\n products to do tasks such as web indexing, data mining, log file analysis, machine\n learning, scientific simulation, and data warehousing.</p>\n\n ",
|
||||
"documentation": "\n\n <p>Amazon Elastic MapReduce (Amazon EMR) is a web service that makes it easy to process large amounts of\n data efficiently. Amazon EMR uses Hadoop processing combined with several AWS\n products to do tasks such as web indexing, data mining, log file analysis, machine\n learning, scientific simulation, and data warehousing.</p>\n\n ",
|
||||
"operations": {
|
||||
"AddInstanceGroups": {
|
||||
"name": "AddInstanceGroups",
|
||||
|
|
@ -588,7 +588,7 @@
|
|||
"ServiceRole": {
|
||||
"shape_name": "String",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The IAM role that was specified when the job flow was launched. Amazon ElasticMapReduce will assume this role to work with AWS resources on your behalf.</p>\n "
|
||||
"documentation": "\n <p>The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>This output contains the details for the requested cluster.</p>\n "
|
||||
|
|
@ -1252,7 +1252,7 @@
|
|||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 0,
|
||||
"max_length": 10280,
|
||||
"documentation": "\n <p>The IAM role that was specified when the job flow was launched. Amazon ElasticMapReduce will assume this role to work with AWS resources on your behalf.</p>\n "
|
||||
"documentation": "\n <p>The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p> A description of a job flow.</p>\n "
|
||||
|
|
@ -2858,7 +2858,7 @@
|
|||
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
||||
"min_length": 0,
|
||||
"max_length": 10280,
|
||||
"documentation": "\n <p>IAM role that Amazon ElasticMapReduce will assume to work with AWS resources on your behalf. You may set this parameter to the name of an existing IAM role.</p>\n "
|
||||
"documentation": "\n <p>The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.</p>\n "
|
||||
},
|
||||
"Tags": {
|
||||
"shape_name": "TagList",
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
"global_endpoint": "iam.amazonaws.com",
|
||||
"endpoint_prefix": "iam",
|
||||
"xmlnamespace": "https://iam.amazonaws.com/doc/2010-05-08/",
|
||||
"documentation": "\n\t\t<fullname>AWS Identity and Access Management</fullname>\n\t\t\n\t\t<p>AWS Identity and Access Management (IAM) is a web service that you can use to manage users and user permissions\n\t\t\tunder your AWS account. This guide provides descriptions of the IAM API. For general\n\t\t\tinformation about IAM, see <a href=\"http://aws.amazon.com/iam/\" target=\"_blank\">AWS Identity\n\t\t\t\tand Access Management (IAM)</a>. For the user guide for IAM, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/\" target=\"_blank\">Using IAM</a>. </p>\n\t\t\n\t\t<note> AWS provides SDKs that consist of libraries and sample code for various programming\n\t\t\tlanguages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient\n\t\t\tway to create programmatic access to IAM and AWS. For example, the SDKs take care of tasks\n\t\t\tsuch as cryptographically signing requests (see below), managing errors, and retrying requests\n\t\t\tautomatically. For information about the AWS SDKs, including how to download and install them,\n\t\t\tsee the <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services</a> page. </note>\n\t\t\n\t\t<p> Using the IAM Query API, you make direct calls to the IAM web service. IAM supports\n\t\t\tGET and POST requests for all actions. That is, the API does not require you to use GET for\n\t\t\tsome actions and POST for others. However, GET requests are subject to the limitation size of\n\t\t\ta URL; although this limit is browser dependent, a typical limit is 2048 bytes. Therefore, for\n\t\t\toperations that require larger sizes, you must use a POST request. </p>\n\t\t\n\t\t<p><b>Signing Requests</b><br> Requests must be signed using an access key ID and a secret\n\t\t\taccess key. We strongly recommend that you do not use your AWS account access key ID and\n\t\t\tsecret access key for everyday work with IAM. You can use the access key ID and secret access\n\t\t\tkey for an IAM user or you can use the AWS Security Token Service to generate temporary security credentials\n\t\t\tand use those to sign requests.</p> \n\t\t\n\t\t<p>To sign requests, we recommend that you use <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>. If\n\t\t\tyou have an existing application that uses Signature Version 2, you do not have to update it\n\t\t\tto use Signature Version 4. However, some operations now require Signature Version 4. The\n\t\t\tdocumentation for operations that require version 4 indicate this requirement. </p>\n\t\t\n\n\t\t<p><b>Additional Resources</b><br>\n\t\tFor more information, see the following:</p>\n\t\t\n\t\t<ul>\n\t\t\t<li>\n<a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html\" target=\"_blank\">AWS Security Credentials</a>. This topic provides general information about the types of\n\t\t\t\tcredentials used for accessing AWS.</li>\n\t\t\t<li>\n<a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAMBestPractices.html\" target=\"_blank\">IAM\n\t\t\t\t\tBest Practices</a>. This topic presents a list of suggestions for using the IAM service\n\t\t\t\tto help secure your AWS resources.</li>\n\t\t\t<li>\n<a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/\" target=\"_blank\">AWS Security Token Service</a>. This guide\n\t\t\t\tdescribes how to create and use temporary security credentials.</li>\n\t\t\t<li>\n<a href=\"http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html\" target=\"_blank\">Signing AWS API Requests</a>. This set of topics walk you through the process of signing\n\t\t\t\ta request using an access key ID and secret access key.</li>\n\t\t</ul>\n\t",
|
||||
"documentation": "\n\t\t<fullname>AWS Identity and Access Management</fullname>\n\n\t\t<p>AWS Identity and Access Management (IAM) is a web service that you can use to manage users and user permissions\n\t\t\tunder your AWS account. This guide provides descriptions of the IAM API. For general\n\t\t\tinformation about IAM, see <a href=\"http://aws.amazon.com/iam/\">AWS Identity\n\t\t\t\tand Access Management (IAM)</a>. For the user guide for IAM, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/\">Using IAM</a>. </p>\n\n\t\t<note>AWS provides SDKs that consist of libraries and sample code for various programming\n\t\t\tlanguages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient\n\t\t\tway to create programmatic access to IAM and AWS. For example, the SDKs take care of tasks\n\t\t\tsuch as cryptographically signing requests (see below), managing errors, and retrying requests\n\t\t\tautomatically. For information about the AWS SDKs, including how to download and install them,\n\t\t\tsee the <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services</a> page. </note>\n\n\t\t<p> Using the IAM Query API, you make direct calls to the IAM web service. IAM supports\n\t\t\tGET and POST requests for all actions. That is, the API does not require you to use GET for\n\t\t\tsome actions and POST for others. However, GET requests are subject to the limitation size of\n\t\t\ta URL. Therefore, for operations that require larger sizes, use a POST request. </p>\n\n\t\t<p><b>Signing Requests</b></p>\n\t\t<p>Requests must be signed using an access key ID and a secret\n\t\taccess key. We strongly recommend that you do not use your AWS account access key ID and\n\t\tsecret access key for everyday work with IAM. You can use the access key ID and secret access\n\t\tkey for an IAM user or you can use the AWS Security Token Service to generate temporary security credentials\n\t\tand use those to sign requests.\n\t\t</p>\n\n\t\t<p>To sign requests, we recommend that you use <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>. If\n\t\t\tyou have an existing application that uses Signature Version 2, you do not have to update it\n\t\t\tto use Signature Version 4. However, some operations now require Signature Version 4. The\n\t\t\tdocumentation for operations that require version 4 indicate this requirement. </p>\n\n\t\t<p><b>Recording API requests</b></p>\n\t\t<p>\n\t\t\tIAM supports AWS CloudTrail, which is a service that records AWS calls for your AWS account and delivers\n\t\t\tlog files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine what\n\t\t\trequests were successfully made to IAM, who made the request, when it was made, and so on. To learn more about\n\t\t\tCloudTrail, including how to turn it on and find your log files, see the\n\t\t\t<a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/whatisawscloudtrail.html\">AWS CloudTrail User Guide</a>.\n\t\t</p>\n\n\t\t<p><b>Additional Resources</b></p>\n\t\t<p>For more information, see the following:</p>\n\t\t<ul>\n\t\t\t<li>\n<a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html\">AWS Security Credentials</a>. This topic provides general information about the types of\n\t\t\t\tcredentials used for accessing AWS.</li>\n\t\t\t<li>\n<a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAMBestPractices.html\">IAM\n\t\t\t\t\tBest Practices</a>. This topic presents a list of suggestions for using the IAM service\n\t\t\t\tto help secure your AWS resources.</li>\n\t\t\t<li>\n<a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/\">AWS Security Token Service</a>. This guide\n\t\t\t\tdescribes how to create and use temporary security credentials.</li>\n\t\t\t<li>\n<a href=\"http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html\">Signing AWS API Requests</a>. This set of topics walk you through the process of signing\n\t\t\t\ta request using an access key ID and secret access key.</li>\n\t\t</ul>\n\t",
|
||||
"operations": {
|
||||
"AddRoleToInstanceProfile": {
|
||||
"name": "AddRoleToInstanceProfile",
|
||||
|
|
@ -46,7 +46,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -58,7 +58,7 @@
|
|||
"message": {
|
||||
"shape_name": "entityAlreadyExistsMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create a resource that already exists.</p>\n\t"
|
||||
|
|
@ -70,7 +70,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -114,7 +114,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -126,7 +126,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -147,7 +147,7 @@
|
|||
"max_length": 128,
|
||||
"pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+",
|
||||
"sensitive": true,
|
||||
"documentation": null,
|
||||
"documentation": "\n <p>The IAM users's current password.</p> \n ",
|
||||
"required": true
|
||||
},
|
||||
"NewPassword": {
|
||||
|
|
@ -157,11 +157,11 @@
|
|||
"max_length": 128,
|
||||
"pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+",
|
||||
"sensitive": true,
|
||||
"documentation": null,
|
||||
"documentation": "\n <p>The new password. The new password must conform to the AWS account's password policy, if one exists.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": null
|
||||
"documentation": " "
|
||||
},
|
||||
"output": null,
|
||||
"errors": [
|
||||
|
|
@ -172,7 +172,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -196,7 +196,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -208,13 +208,25 @@
|
|||
"message": {
|
||||
"shape_name": "entityTemporarilyUnmodifiableMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that is temporarily unmodifiable,\n\t\t\tsuch as a user name that was deleted and then recreated. The error indicates that the request\n\t\t\tis likely to succeed if you try again after waiting several minutes. The error message\n\t\t\tdescribes the entity.</p>\n\t"
|
||||
},
|
||||
{
|
||||
"shape_name": "PasswordPolicyViolationException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "passwordPolicyViolationMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because the provided password did not meet the requirements imposed\n\t\t\tby the account password policy.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Changes the password of the IAM user calling <code>ChangePassword</code>. The root account\n\t\t\tpassword is not affected by this action. For information about modifying passwords, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html\" target=\"_blank\">Managing Passwords</a>.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=ChangePassword\n&OldPassword=U79}kgds4?\n&NewPassword=Lb0*1(9xpN\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<ChangePasswordResponse>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</ChangePasswordResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Changes the password of the IAM user calling <code>ChangePassword</code>. The root account\n\t\t\tpassword is not affected by this action. For information about modifying passwords, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html\">Managing Passwords</a> in the <i>Using IAM</i> guide.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=ChangePassword\n&OldPassword=U79}kgds4?\n&NewPassword=Lb0*1(9xpN\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<ChangePasswordResponse>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</ChangePasswordResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"CreateAccessKey": {
|
||||
"name": "CreateAccessKey",
|
||||
|
|
@ -296,7 +308,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -308,13 +320,13 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Creates a new AWS secret access key and corresponding AWS access key ID for the specified\n\t\t\tuser. The default status for new keys is <code>Active</code>.</p>\n\t\t<p>If you do not specify a user name, IAM determines the user name implicitly based on the AWS\n\t\t\taccess key ID signing the request. Because this action works for access keys under the AWS\n\t\t\taccount, you can use this API to manage root credentials even if the AWS account has no\n\t\t\tassociated users.</p>\n\t\t<p>For information about limits on the number of keys you can create, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?LimitationsOnEntities.html\" target=\"_blank\">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<important>To ensure the security of your AWS account, the secret access key is accessible only\n\t\t\tduring key and user creation. You must save the key (for example, in a text file) if you want\n\t\t\tto be able to access it again. If a secret key is lost, you can delete the access keys for the\n\t\t\tassociated user and then create new keys.</important>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=CreateAccessKey\n&UserName=Bob\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<CreateAccessKeyResponse>\n <CreateAccessKeyResult>\n <AccessKey>\n <UserName>Bob</UserName>\n <AccessKeyId>AKIAIOSFODNN7EXAMPLE</AccessKeyId>\n <Status>Active</Status>\n <SecretAccessKey>wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY\n </SecretAccessKey>\n </AccessKey>\n </CreateAccessKeyResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</CreateAccessKeyResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Creates a new AWS secret access key and corresponding AWS access key ID for the specified\n\t\t\tuser. The default status for new keys is <code>Active</code>.</p>\n\t\t<p>If you do not specify a user name, IAM determines the user name implicitly based on the AWS\n\t\t\taccess key ID signing the request. Because this action works for access keys under the AWS\n\t\t\taccount, you can use this API to manage root credentials even if the AWS account has no\n\t\t\tassociated users.</p>\n\t\t<p>For information about limits on the number of keys you can create, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t\t<important>To ensure the security of your AWS account, the secret access key is accessible only\n\t\t\tduring key and user creation. You must save the key (for example, in a text file) if you want\n\t\t\tto be able to access it again. If a secret key is lost, you can delete the access keys for the\n\t\t\tassociated user and then create new keys.</important>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=CreateAccessKey\n&UserName=Bob\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<CreateAccessKeyResponse>\n <CreateAccessKeyResult>\n <AccessKey>\n <UserName>Bob</UserName>\n <AccessKeyId>AKIAIOSFODNN7EXAMPLE</AccessKeyId>\n <Status>Active</Status>\n <SecretAccessKey>wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY\n </SecretAccessKey>\n </AccessKey>\n </CreateAccessKeyResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</CreateAccessKeyResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"CreateAccountAlias": {
|
||||
"name": "CreateAccountAlias",
|
||||
|
|
@ -343,7 +355,7 @@
|
|||
"message": {
|
||||
"shape_name": "entityAlreadyExistsMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create a resource that already exists.</p>\n\t"
|
||||
|
|
@ -355,13 +367,13 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>This action creates an alias for your AWS account. For information about using an AWS account\n\t\t\talias, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html\" target=\"_blank\">Using an Alias for Your AWS Account ID</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=CreateAccountAlias\n&AccountAlias=foocorporation\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<CreateAccountAliasResponse>\n <ResponseMetadata>\n <RequestId>36b5db08-f1b0-11df-8fbe-45274EXAMPLE</RequestId>\n </ResponseMetadata>\n</CreateAccountAliasResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>This action creates an alias for your AWS account. For information about using an AWS account\n\t\t\talias, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html\">Using an Alias for Your AWS Account ID</a> in the <i>Using IAM</i> guide.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=CreateAccountAlias\n&AccountAlias=foocorporation\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<CreateAccountAliasResponse>\n <ResponseMetadata>\n <RequestId>36b5db08-f1b0-11df-8fbe-45274EXAMPLE</RequestId>\n </ResponseMetadata>\n</CreateAccountAliasResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"CreateGroup": {
|
||||
"name": "CreateGroup",
|
||||
|
|
@ -375,7 +387,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>The path to the group. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<p>This parameter is optional. If it is not included, it defaults to a slash (/).</p>\n\t"
|
||||
"documentation": "\n\t\t<p>The path to the group. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t\t<p>This parameter is optional. If it is not included, it defaults to a slash (/).</p>\n\t"
|
||||
},
|
||||
"GroupName": {
|
||||
"shape_name": "groupNameType",
|
||||
|
|
@ -403,7 +415,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the group. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the group. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"GroupName": {
|
||||
|
|
@ -421,7 +433,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the group. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the group. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -429,7 +441,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -453,7 +465,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -465,7 +477,7 @@
|
|||
"message": {
|
||||
"shape_name": "entityAlreadyExistsMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create a resource that already exists.</p>\n\t"
|
||||
|
|
@ -477,13 +489,13 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Creates a new group.</p>\n\t\t<p>For information about the number of groups you can create, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?LimitationsOnEntities.html\" target=\"_blank\">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=CreateGroup\n&Path=/\n&GroupName=Admins\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<CreateGroupResponse>\n <CreateGroupResult>\n <Group>\n <Path>/</Path>\n <GroupName>Admins</GroupName>\n <GroupId>AGPACKCEVSQ6C2EXAMPLE</GroupId>\n <Arn>arn:aws:iam::123456789012:group/Admins</Arn>\n </Group>\n </CreateGroupResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</CreateGroupResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Creates a new group.</p>\n\t\t<p>For information about the number of groups you can create, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=CreateGroup\n&Path=/\n&GroupName=Admins\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<CreateGroupResponse>\n <CreateGroupResult>\n <Group>\n <Path>/</Path>\n <GroupName>Admins</GroupName>\n <GroupId>AGPACKCEVSQ6C2EXAMPLE</GroupId>\n <Arn>arn:aws:iam::123456789012:group/Admins</Arn>\n </Group>\n </CreateGroupResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</CreateGroupResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"CreateInstanceProfile": {
|
||||
"name": "CreateInstanceProfile",
|
||||
|
|
@ -506,7 +518,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>The path to the instance profile. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<p>This parameter is optional. If it is not included, it defaults to a slash (/).</p>\n\t"
|
||||
"documentation": "\n\t\t<p>The path to the instance profile. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t\t<p>This parameter is optional. If it is not included, it defaults to a slash (/).</p>\n\t"
|
||||
}
|
||||
},
|
||||
"documentation": " "
|
||||
|
|
@ -525,7 +537,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the instance profile. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the instance profile. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"InstanceProfileName": {
|
||||
|
|
@ -543,7 +555,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -551,7 +563,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -573,7 +585,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the role. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the role. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"RoleName": {
|
||||
|
|
@ -591,7 +603,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the role. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the role. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -599,7 +611,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -637,7 +649,7 @@
|
|||
"message": {
|
||||
"shape_name": "entityAlreadyExistsMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create a resource that already exists.</p>\n\t"
|
||||
|
|
@ -649,13 +661,13 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Creates a new instance profile. For information about instance profiles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html\">About Instance\n\t\t\t\tProfiles</a>.</p>\n\t\t<p>For information about the number of instance profiles you can create, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?LimitationsOnEntities.html\" target=\"_blank\">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=CreateInstanceProfile\n&InstanceProfileName=Webserver\n&Path=/application_abc/component_xyz/\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<CreateInstanceProfileResponse xmlns=\"https://iam.amazonaws.com/doc/2010-05-08/\">\n <CreateInstanceProfileResult>\n <InstanceProfile>\n <InstanceProfileId>AIPAD5ARO2C5EXAMPLE3G</InstanceProfileId>\n <Roles/>\n <InstanceProfileName>Webserver</InstanceProfileName>\n <Path>/application_abc/component_xyz/</Path>\n <Arn>arn:aws:iam::123456789012:instance-profile/application_abc/component_xyz/Webserver</Arn>\n <CreateDate>2012-05-09T16:11:10.222Z</CreateDate>\n </InstanceProfile>\n </CreateInstanceProfileResult>\n <ResponseMetadata>\n <RequestId>974142ee-99f1-11e1-a4c3-27EXAMPLE804</RequestId>\n </ResponseMetadata>\n</CreateInstanceProfileResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Creates a new instance profile. For information about instance profiles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html\">About Instance\n\t\t\t\tProfiles</a>.</p>\n\t\t<p>For information about the number of instance profiles you can create, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=CreateInstanceProfile\n&InstanceProfileName=Webserver\n&Path=/application_abc/component_xyz/\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<CreateInstanceProfileResponse xmlns=\"https://iam.amazonaws.com/doc/2010-05-08/\">\n <CreateInstanceProfileResult>\n <InstanceProfile>\n <InstanceProfileId>AIPAD5ARO2C5EXAMPLE3G</InstanceProfileId>\n <Roles/>\n <InstanceProfileName>Webserver</InstanceProfileName>\n <Path>/application_abc/component_xyz/</Path>\n <Arn>arn:aws:iam::123456789012:instance-profile/application_abc/component_xyz/Webserver</Arn>\n <CreateDate>2012-05-09T16:11:10.222Z</CreateDate>\n </InstanceProfile>\n </CreateInstanceProfileResult>\n <ResponseMetadata>\n <RequestId>974142ee-99f1-11e1-a4c3-27EXAMPLE804</RequestId>\n </ResponseMetadata>\n</CreateInstanceProfileResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"CreateLoginProfile": {
|
||||
"name": "CreateLoginProfile",
|
||||
|
|
@ -679,8 +691,13 @@
|
|||
"max_length": 128,
|
||||
"pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+",
|
||||
"sensitive": true,
|
||||
"documentation": "\n\t\t<p>The new password for the user name.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The new password for the user.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"PasswordResetRequired": {
|
||||
"shape_name": "booleanType",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Specifies whether the user is required to set a new password on next sign-in.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": " "
|
||||
|
|
@ -699,7 +716,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 64,
|
||||
"pattern": "[\\w+=,.@-]*",
|
||||
"documentation": "\n\t\t<p>The name of the user, which can be used for signing into the AWS Management Console.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The name of the user, which can be used for signing in to the AWS Management Console.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -707,6 +724,11 @@
|
|||
"type": "timestamp",
|
||||
"documentation": "\n\t\t<p>The date when the password for the user was created.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"PasswordResetRequired": {
|
||||
"shape_name": "booleanType",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Specifies whether the user is required to set a new password on next sign-in.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The user name and password create date.</p>\n\t",
|
||||
|
|
@ -723,7 +745,7 @@
|
|||
"message": {
|
||||
"shape_name": "entityAlreadyExistsMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create a resource that already exists.</p>\n\t"
|
||||
|
|
@ -735,7 +757,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -759,13 +781,13 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Creates a password for the specified user, giving the user the ability to access AWS services\n\t\t\tthrough the AWS Management Console. For more information about managing passwords, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_ManagingLogins.html\" target=\"_blank\">Managing Passwords</a> in <i>Using IAM</i>.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=CreateLoginProfile\n&UserName=Bob\n&Password=Password1\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<CreateLoginProfileResponse>\n <CreateUserResult>\n <LoginProfile>\n <UserName>Bob</UserName>\n <CreateDate>2011-09-19T23:00:56Z</CreateDate>\n </LoginProfile>\n </CreateUserResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</CreateLoginProfileResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Creates a password for the specified user, giving the user the ability to access AWS services\n\t\t\tthrough the AWS Management Console. For more information about managing passwords, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html\">Managing Passwords</a> in the <i>Using IAM</i> guide.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=CreateLoginProfile\n&UserName=Bob\n&Password=Password1\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<CreateLoginProfileResponse>\n <CreateUserResult>\n <LoginProfile>\n <UserName>Bob</UserName>\n <CreateDate>2011-09-19T23:00:56Z</CreateDate>\n </LoginProfile>\n </CreateUserResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</CreateLoginProfileResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"CreateRole": {
|
||||
"name": "CreateRole",
|
||||
|
|
@ -779,7 +801,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>The path to the role. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<p>This parameter is optional. If it is not included, it defaults to a slash (/).</p>\n\t"
|
||||
"documentation": "\n\t\t<p>The path to the role. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t\t<p>This parameter is optional. If it is not included, it defaults to a slash (/).</p>\n\t"
|
||||
},
|
||||
"RoleName": {
|
||||
"shape_name": "roleNameType",
|
||||
|
|
@ -816,7 +838,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the role. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the role. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"RoleName": {
|
||||
|
|
@ -834,7 +856,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the role. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the role. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -842,7 +864,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -874,7 +896,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -886,7 +908,7 @@
|
|||
"message": {
|
||||
"shape_name": "entityAlreadyExistsMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create a resource that already exists.</p>\n\t"
|
||||
|
|
@ -898,13 +920,13 @@
|
|||
"message": {
|
||||
"shape_name": "malformedPolicyDocumentMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Creates a new role for your AWS account. For more information about roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html\">Working with Roles</a>.\n\t\t\tFor information about limitations on role names and the number of roles you can create, go to\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?LimitationsOnEntities.html\" target=\"_blank\">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<p>The policy grants permission to an EC2 instance to assume the role. The policy is URL-encoded\n\t\t\taccording to RFC 3986. For more information about RFC 3986, go to <a href=\"http://www.faqs.org/rfcs/rfc3986.html\">http://www.faqs.org/rfcs/rfc3986.html</a>.\n\t\t\tCurrently, only EC2 instances can assume roles.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=CreateRole\n&RoleName=S3Access\n&Path=/application_abc/component_xyz/\n&AssumeRolePolicyDocument={\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}\n&Version=2010-05-08\n&AUTHPARAMS\n\t\t\t</queryrequest>\n\t\t\t<queryresponse>\n<CreateRoleResponse xmlns=\"https://iam.amazonaws.com/doc/2010-05-08/\">\n <CreateRoleResult>\n <Role>\n <Path>/application_abc/component_xyz/</Path>\n <Arn>arn:aws:iam::123456789012:role/application_abc/component_xyz/S3Access</Arn>\n <RoleName>S3Access</RoleName>\n <AssumeRolePolicyDocument>{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}</AssumeRolePolicyDocument>\n <CreateDate>2012-05-08T23:34:01.495Z</CreateDate>\n <RoleId>AROADBQP57FF2AEXAMPLE</RoleId>\n </Role>\n </CreateRoleResult>\n <ResponseMetadata>\n <RequestId>4a93ceee-9966-11e1-b624-b1aEXAMPLE7c</RequestId>\n </ResponseMetadata>\n</CreateRoleResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Creates a new role for your AWS account. For more information about roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html\">Working with Roles</a>.\n\t\t\tFor information about limitations on role names and the number of roles you can create, go to\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t\t<p>The example policy grants permission to an EC2 instance to assume the role. The policy is URL-encoded\n\t\t\taccording to RFC 3986. For more information about RFC 3986, go to <a href=\"http://www.faqs.org/rfcs/rfc3986.html\">http://www.faqs.org/rfcs/rfc3986.html</a>.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=CreateRole\n&RoleName=S3Access\n&Path=/application_abc/component_xyz/\n&AssumeRolePolicyDocument={\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}\n&Version=2010-05-08\n&AUTHPARAMS\n\t\t\t</queryrequest>\n\t\t\t<queryresponse>\n<CreateRoleResponse xmlns=\"https://iam.amazonaws.com/doc/2010-05-08/\">\n <CreateRoleResult>\n <Role>\n <Path>/application_abc/component_xyz/</Path>\n <Arn>arn:aws:iam::123456789012:role/application_abc/component_xyz/S3Access</Arn>\n <RoleName>S3Access</RoleName>\n <AssumeRolePolicyDocument>{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}</AssumeRolePolicyDocument>\n <CreateDate>2012-05-08T23:34:01.495Z</CreateDate>\n <RoleId>AROADBQP57FF2AEXAMPLE</RoleId>\n </Role>\n </CreateRoleResult>\n <ResponseMetadata>\n <RequestId>4a93ceee-9966-11e1-b624-b1aEXAMPLE7c</RequestId>\n </ResponseMetadata>\n</CreateRoleResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"CreateSAMLProvider": {
|
||||
"name": "CreateSAMLProvider",
|
||||
|
|
@ -917,7 +939,7 @@
|
|||
"type": "string",
|
||||
"min_length": 1000,
|
||||
"max_length": 10000000,
|
||||
"documentation": "\n\t\t<p>An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document\n\t\t\tincludes the issuer's name, expiration information, and keys that can be used to validate the\n\t\t\tSAML authentication response (assertions) that are received from the IdP. You must generate\n\t\t\tthe metadata document using the identity management software that is used as your\n\t\t\torganization's IdP. </p>\n\t\t\n\t\t<p>For more information, see <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/CreatingSAML.html\">Creating Temporary Security Credentials for SAML Federation</a> in the <i>Using Temporary\n\t\t\t\tSecurity Credentials</i> guide. </p>\n\t\t\n\t",
|
||||
"documentation": "\n\t\t<p>An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document\n\t\t\tincludes the issuer's name, expiration information, and keys that can be used to validate the\n\t\t\tSAML authentication response (assertions) that are received from the IdP. You must generate\n\t\t\tthe metadata document using the identity management software that is used as your\n\t\t\torganization's IdP. </p>\n\n\t\t<p>For more information, see <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/CreatingSAML.html\">Creating Temporary Security Credentials for SAML Federation</a> in the <i>Using Temporary\n\t\t\t\tSecurity Credentials</i> guide. </p>\n\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Name": {
|
||||
|
|
@ -966,7 +988,7 @@
|
|||
"message": {
|
||||
"shape_name": "entityAlreadyExistsMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create a resource that already exists.</p>\n\t"
|
||||
|
|
@ -978,13 +1000,13 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Creates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0.</p>\n\t\t<p>The SAML provider that you create with this operation can be used as a principal in a role's\n\t\t\ttrust policy to establish a trust relationship between AWS and a SAML identity provider. You\n\t\t\tcan create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one\n\t\t\tthat supports API access to AWS. </p>\n\t\t\n\t\t<p>When you create the SAML provider, you upload an a SAML metadata document that you get from\n\t\t\tyour IdP and that includes the issuer's name, expiration information, and keys that can be\n\t\t\tused to validate the SAML authentication response (assertions) that are received from the IdP.\n\t\t\tYou must generate the metadata document using the identity management software that is used as\n\t\t\tyour organization's IdP. </p>\n\t\t\n\t\t<note>This operation requires <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version\n\t\t\t4</a>.</note>\n\t\t\n\t\t<p>For more information, see <a href=\"http://aws-docs-alpha.integ.amazon.com/STS/latest/UsingSTS/STSMgmtConsole-SAML.html\">Giving Console Access Using SAML</a> and <a href=\"http://aws-docs-alpha.integ.amazon.com/STS/latest/UsingSTS/CreatingSAML.html\">Creating\n\t\t\t\tTemporary Security Credentials for SAML Federation</a> in the <i>Using Temporary\n\t\t\t\tCredentials</i> guide. </p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=CreateSAMLProvider\n&Name=MyUniversity\n&SAMLProviderDocument=VGhpcyBpcyB3aGVyZSB5b3UgcHV0IHRoZSBTQU1MIHByb3ZpZGVyIG1ldGFkYXRhIGRvY3VtZW50\nLCBCYXNlNjQtZW5jb2RlZCBpbnRvIGEgYmlnIHN0cmluZy4=\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<CreateSAMLProviderResponse xmlns=\"https://iam.amazonaws.com/doc/2010-05-08/\">\n <CreateSAMLProviderResult>\n <SAMLProviderArn>arn:aws:iam::123456789012:saml-metadata/MyUniversity</SAMLProviderArn>\n </CreateSAMLProviderResult>\n <ResponseMetadata>\n <RequestId>29f47818-99f5-11e1-a4c3-27EXAMPLE804</RequestId>\n </ResponseMetadata>\n</CreateSAMLProviderResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Creates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0.</p>\n\t\t<p>The SAML provider that you create with this operation can be used as a principal in a role's\n\t\t\ttrust policy to establish a trust relationship between AWS and a SAML identity provider. You\n\t\t\tcan create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one\n\t\t\tthat supports API access to AWS. </p>\n\n\t\t<p>When you create the SAML provider, you upload an a SAML metadata document that you get from\n\t\t\tyour IdP and that includes the issuer's name, expiration information, and keys that can be\n\t\t\tused to validate the SAML authentication response (assertions) that are received from the IdP.\n\t\t\tYou must generate the metadata document using the identity management software that is used as\n\t\t\tyour organization's IdP. </p>\n\n\n\t\t<note>This operation requires <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version\n\t\t\t4</a>.</note>\n\n\t\t<p>For more information, see <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/STSMgmtConsole-SAML.html\">Giving Console Access Using SAML</a> and <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/CreatingSAML.html\">Creating\n\t\t\t\tTemporary Security Credentials for SAML Federation</a> in the <i>Using Temporary\n\t\t\t\tCredentials</i> guide. </p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=CreateSAMLProvider\n&Name=MyUniversity\n&SAMLProviderDocument=VGhpcyBpcyB3aGVyZSB5b3UgcHV0IHRoZSBTQU1MIHByb3ZpZGVyIG1ldGFkYXRhIGRvY3VtZW50\nLCBCYXNlNjQtZW5jb2RlZCBpbnRvIGEgYmlnIHN0cmluZy4=\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<CreateSAMLProviderResponse xmlns=\"https://iam.amazonaws.com/doc/2010-05-08/\">\n <CreateSAMLProviderResult>\n <SAMLProviderArn>arn:aws:iam::123456789012:saml-metadata/MyUniversity</SAMLProviderArn>\n </CreateSAMLProviderResult>\n <ResponseMetadata>\n <RequestId>29f47818-99f5-11e1-a4c3-27EXAMPLE804</RequestId>\n </ResponseMetadata>\n</CreateSAMLProviderResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"CreateUser": {
|
||||
"name": "CreateUser",
|
||||
|
|
@ -998,7 +1020,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>The path for the user name. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<p>This parameter is optional. If it is not included, it defaults to a slash (/).</p>\n\t"
|
||||
"documentation": "\n\t\t<p>The path for the user name. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t\t<p>This parameter is optional. If it is not included, it defaults to a slash (/).</p>\n\t"
|
||||
},
|
||||
"UserName": {
|
||||
"shape_name": "userNameType",
|
||||
|
|
@ -1026,7 +1048,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the user. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the user. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"UserName": {
|
||||
|
|
@ -1044,7 +1066,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the user. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the user. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -1052,7 +1074,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -1075,7 +1097,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -1087,7 +1109,7 @@
|
|||
"message": {
|
||||
"shape_name": "entityAlreadyExistsMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create a resource that already exists.</p>\n\t"
|
||||
|
|
@ -1099,13 +1121,13 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Creates a new user for your AWS account.</p>\n\t\t<p>For information about limitations on the number of users you can create, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?LimitationsOnEntities.html\" target=\"_blank\">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=CreateUser\n&Path=/division_abc/subdivision_xyz/\n&UserName=Bob\n&Version=2010-05-08\n&AUTHPARAMS\n\t\t\t</queryrequest>\n\t\t\t<queryresponse>\n<CreateUserResponse>\n <CreateUserResult>\n <User>\n <Path>/division_abc/subdivision_xyz/</Path>\n <UserName>Bob</UserName>\n <UserId>AIDACKCEVSQ6C2EXAMPLE</UserId>\n <Arn>arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/Bob\n </Arn>\n </User>\n </CreateUserResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</CreateUserResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Creates a new user for your AWS account.</p>\n\t\t<p>For information about limitations on the number of users you can create, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=CreateUser\n&Path=/division_abc/subdivision_xyz/\n&UserName=Bob\n&Version=2010-05-08\n&AUTHPARAMS\n\t\t\t</queryrequest>\n\t\t\t<queryresponse>\n<CreateUserResponse>\n <CreateUserResult>\n <User>\n <Path>/division_abc/subdivision_xyz/</Path>\n <UserName>Bob</UserName>\n <UserId>AIDACKCEVSQ6C2EXAMPLE</UserId>\n <Arn>arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/Bob\n </Arn>\n </User>\n </CreateUserResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</CreateUserResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"CreateVirtualMFADevice": {
|
||||
"name": "CreateVirtualMFADevice",
|
||||
|
|
@ -1119,7 +1141,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>The path for the virtual MFA device. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<p>This parameter is optional. If it is not included, it defaults to a slash (/).</p>\n\t"
|
||||
"documentation": "\n\t\t<p>The path for the virtual MFA device. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t\t<p>This parameter is optional. If it is not included, it defaults to a slash (/).</p>\n\t"
|
||||
},
|
||||
"VirtualMFADeviceName": {
|
||||
"shape_name": "virtualMFADeviceName",
|
||||
|
|
@ -1130,7 +1152,7 @@
|
|||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": null
|
||||
"documentation": " "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CreateVirtualMFADeviceResponse",
|
||||
|
|
@ -1153,7 +1175,7 @@
|
|||
"shape_name": "BootstrapDatum",
|
||||
"type": "blob",
|
||||
"sensitive": true,
|
||||
"documentation": "\n\t\t<p>The Base32 seed defined as specified in <a href=\"http://www.ietf.org/rfc/rfc3548.txt\" target=\"_blank\">RFC3548</a>. The <code>Base32StringSeed</code> is Base64-encoded.</p>\n\t"
|
||||
"documentation": "\n\t\t<p>The Base32 seed defined as specified in <a href=\"http://www.ietf.org/rfc/rfc3548.txt\">RFC3548</a>. The <code>Base32StringSeed</code> is Base64-encoded.</p>\n\t"
|
||||
},
|
||||
"QRCodePNG": {
|
||||
"shape_name": "BootstrapDatum",
|
||||
|
|
@ -1171,7 +1193,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the user. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the user. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"UserName": {
|
||||
|
|
@ -1189,7 +1211,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the user. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the user. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -1197,7 +1219,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -1229,7 +1251,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -1241,13 +1263,13 @@
|
|||
"message": {
|
||||
"shape_name": "entityAlreadyExistsMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create a resource that already exists.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use <a href=\"http://docs.aws.amazon.com/IAM/latest/APIReference/API_EnableMFADevice.html\" target=\"_blank\">EnableMFADevice</a> to attach the MFA device to an IAM user. For more information about\n\t\t\tcreating and working with virtual MFA devices, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_VirtualMFA.html\" target=\"_blank\">Using a Virtual MFA Device</a> in <i>Using AWS Identity and Access Management</i>.</p>\n\t\t<p>For information about limits on the number of MFA devices you can create, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?LimitationsOnEntities.html\" target=\"_blank\">Limitations on Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<important>The seed information contained in the QR code and the Base32 string should be treated\n\t\t\tlike any other secret access information, such as your AWS access keys or your passwords.\n\t\t\tAfter you provision your virtual device, you should ensure that the information is destroyed\n\t\t\tfollowing secure procedures.</important>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=CreateVirtualMFADevice\n&VirtualMFADeviceName=ExampleName\n&Path=/\n&Version=2010-05-08\n&AUTHPARAMS\n</queryrequest>\n\t\t\t<queryresponse>\n<CreateVirtualMFADeviceResponse>\n <CreateVirtualMFADeviceResult>\n <VirtualMFADevice>\n <SerialNumber>arn:aws:iam::123456789012:mfa/ExampleName</SerialNumber>\n <Base32StringSeed>2K5K5XTLA7GGE75TQLYEXAMPLEEXAMPLEEXAMPLECHDFW4KJYZ6\n UFQ75LL7COCYKM</Base32StringSeed>\n <QRCodePNG>89504E470D0A1A0AASDFAHSDFKJKLJFKALSDFJASDF</QRCodePNG> <!-- byte array of png file -->\n </VirtualMFADevice>\n </CreateVirtualMFADeviceResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</CreateVirtualMFADeviceResponse>\n</queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use <a href=\"http://docs.aws.amazon.com/IAM/latest/APIReference/API_EnableMFADevice.html\">EnableMFADevice</a> to attach the MFA device to an IAM user. For more information about\n\t\t\tcreating and working with virtual MFA devices, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html\">Using a Virtual MFA Device</a> in the <i>Using IAM</i> guide.</p>\n\t\t<p>For information about limits on the number of MFA devices you can create, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on Entities</a> in the <i>Using IAM</i> guide.</p>\n\t\t<important>The seed information contained in the QR code and the Base32 string should be treated\n\t\t\tlike any other secret access information, such as your AWS access keys or your passwords.\n\t\t\tAfter you provision your virtual device, you should ensure that the information is destroyed\n\t\t\tfollowing secure procedures.</important>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=CreateVirtualMFADevice\n&VirtualMFADeviceName=ExampleName\n&Path=/\n&Version=2010-05-08\n&AUTHPARAMS\n</queryrequest>\n\t\t\t<queryresponse>\n<CreateVirtualMFADeviceResponse>\n <CreateVirtualMFADeviceResult>\n <VirtualMFADevice>\n <SerialNumber>arn:aws:iam::123456789012:mfa/ExampleName</SerialNumber>\n <Base32StringSeed>2K5K5XTLA7GGE75TQLYEXAMPLEEXAMPLEEXAMPLECHDFW4KJYZ6\n UFQ75LL7COCYKM</Base32StringSeed>\n <QRCodePNG>89504E470D0A1A0AASDFAHSDFKJKLJFKALSDFJASDF</QRCodePNG> <!-- byte array of png file -->\n </VirtualMFADevice>\n </CreateVirtualMFADeviceResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</CreateVirtualMFADeviceResponse>\n</queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"DeactivateMFADevice": {
|
||||
"name": "DeactivateMFADevice",
|
||||
|
|
@ -1285,7 +1307,7 @@
|
|||
"message": {
|
||||
"shape_name": "entityTemporarilyUnmodifiableMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that is temporarily unmodifiable,\n\t\t\tsuch as a user name that was deleted and then recreated. The error indicates that the request\n\t\t\tis likely to succeed if you try again after waiting several minutes. The error message\n\t\t\tdescribes the entity.</p>\n\t"
|
||||
|
|
@ -1297,7 +1319,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -1309,7 +1331,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -1352,7 +1374,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -1364,7 +1386,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -1399,7 +1421,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -1411,13 +1433,13 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Deletes the specified AWS account alias. For information about using an AWS account alias,\n\t\t\tsee <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html\" target=\"_blank\">Using an\n\t\t\t\tAlias for Your AWS Account ID</a> in <i>Using AWS Identity and Access Management</i>.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=DeleteAccountAlias\n&AccountAlias=foocorporation\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<DeleteAccountAliasResponse>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</DeleteAccountAliasResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Deletes the specified AWS account alias. For information about using an AWS account alias,\n\t\t\tsee <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html\">Using an\n\t\t\t\tAlias for Your AWS Account ID</a> in the <i>Using IAM</i> guide.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=DeleteAccountAlias\n&AccountAlias=foocorporation\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<DeleteAccountAliasResponse>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</DeleteAccountAliasResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"DeleteAccountPasswordPolicy": {
|
||||
"name": "DeleteAccountPasswordPolicy",
|
||||
|
|
@ -1431,10 +1453,22 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
},
|
||||
{
|
||||
"shape_name": "LimitExceededException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Deletes the password policy for the AWS account.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=DeleteAccountPasswordPolicy\n&Version=2010-05-08\n&AUTHPARAMS\n</queryrequest>\n\t\t\t<queryresponse>\n<DeleteAccountPasswordPolicyResponse>\n <ResponseMetadata>\n\t <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n\t</ResponseMetadata>\n</DeleteAccountPasswordPolicy>\n</queryresponse>\n\t\t</examples>\n\t"
|
||||
|
|
@ -1466,7 +1500,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -1478,7 +1512,7 @@
|
|||
"message": {
|
||||
"shape_name": "deleteConflictMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to delete a resource that has attached\n\t\t\tsubordinate entities. The error message describes these entities.</p>\n\t"
|
||||
|
|
@ -1490,7 +1524,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -1534,7 +1568,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -1546,7 +1580,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -1581,7 +1615,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -1593,7 +1627,7 @@
|
|||
"message": {
|
||||
"shape_name": "deleteConflictMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to delete a resource that has attached\n\t\t\tsubordinate entities. The error message describes these entities.</p>\n\t"
|
||||
|
|
@ -1605,7 +1639,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -1640,7 +1674,7 @@
|
|||
"message": {
|
||||
"shape_name": "entityTemporarilyUnmodifiableMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that is temporarily unmodifiable,\n\t\t\tsuch as a user name that was deleted and then recreated. The error indicates that the request\n\t\t\tis likely to succeed if you try again after waiting several minutes. The error message\n\t\t\tdescribes the entity.</p>\n\t"
|
||||
|
|
@ -1652,7 +1686,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -1664,7 +1698,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -1699,7 +1733,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -1711,7 +1745,7 @@
|
|||
"message": {
|
||||
"shape_name": "deleteConflictMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to delete a resource that has attached\n\t\t\tsubordinate entities. The error message describes these entities.</p>\n\t"
|
||||
|
|
@ -1723,7 +1757,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -1756,7 +1790,7 @@
|
|||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": null
|
||||
"documentation": " "
|
||||
},
|
||||
"output": null,
|
||||
"errors": [
|
||||
|
|
@ -1767,7 +1801,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -1779,7 +1813,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -1817,9 +1851,33 @@
|
|||
}
|
||||
},
|
||||
"documentation": null
|
||||
},
|
||||
{
|
||||
"shape_name": "LimitExceededException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
},
|
||||
{
|
||||
"shape_name": "NoSuchEntityException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Deletes a SAML provider.</p>\n\t\t<p>Deleting the provider does not update any roles that reference the SAML provider as a\n\t\t\tprincipal in their trust policies. Any attempt to assume a role that references a SAML\n\t\t\tprovider that has been deleted will fail. </p>\n\t\t<note>This operation requires <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version\n\t\t\t4</a>.</note>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=DeleteSAMLProvider\n&Name=arn:aws:iam::123456789012:saml-metadata/MyUniversity\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Deletes a SAML provider.</p>\n\t\t<p>Deleting the provider does not update any roles that reference the SAML provider as a\n\t\t\tprincipal in their trust policies. Any attempt to assume a role that references a SAML\n\t\t\tprovider that has been deleted will fail. </p>\n\n\t\t<note>This operation requires <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version\n\t\t\t4</a>.</note>\n\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=DeleteSAMLProvider\n&Name=arn:aws:iam::123456789012:saml-metadata/MyUniversity\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"DeleteServerCertificate": {
|
||||
"name": "DeleteServerCertificate",
|
||||
|
|
@ -1848,7 +1906,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -1860,7 +1918,7 @@
|
|||
"message": {
|
||||
"shape_name": "deleteConflictMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to delete a resource that has attached\n\t\t\tsubordinate entities. The error message describes these entities.</p>\n\t"
|
||||
|
|
@ -1872,7 +1930,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -1915,7 +1973,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -1927,7 +1985,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -1962,7 +2020,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -1974,7 +2032,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -1986,7 +2044,7 @@
|
|||
"message": {
|
||||
"shape_name": "deleteConflictMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to delete a resource that has attached\n\t\t\tsubordinate entities. The error message describes these entities.</p>\n\t"
|
||||
|
|
@ -2030,7 +2088,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -2042,7 +2100,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -2066,7 +2124,7 @@
|
|||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": null
|
||||
"documentation": " "
|
||||
},
|
||||
"output": null,
|
||||
"errors": [
|
||||
|
|
@ -2077,7 +2135,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -2089,7 +2147,7 @@
|
|||
"message": {
|
||||
"shape_name": "deleteConflictMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to delete a resource that has attached\n\t\t\tsubordinate entities. The error message describes these entities.</p>\n\t"
|
||||
|
|
@ -2101,13 +2159,13 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Deletes a virtual MFA device.</p>\n\t\t<note>You must deactivate a user's virtual MFA device before you can delete it. For information\n\t\t\tabout deactivating MFA devices, see <a href=\"http://docs.aws.amazon.com/IAM/latest/APIReference/API_DeactivateMFADevice.html\">DeactivateMFADevice</a>.</note>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=DeleteVirtualMFADevice\n&SerialNumber=arn:aws:iam::123456789012:mfa/ExampleName\n&Version=2010-05-08\n&AUTHPARAMS\n</queryrequest>\n\t\t\t<queryresponse>\n<DeleteVirtualMFADeviceResponse>\n <DeleteVirtualMFADeviceResult>\n <VirtualMFADevice>\n <SerialNumber>arn:aws:iam::123456789012:mfa/ExampleName</SerialNumber>\n </VirtualMFADevice>\n </DeleteVirtualMFADeviceResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</DeleteVirtualMFADeviceResponse>\n</queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Deletes a virtual MFA device.</p>\n\n\t\t<note>You must deactivate a user's virtual MFA device before you can delete it. For information\n\t\t\tabout deactivating MFA devices, see <a href=\"http://docs.aws.amazon.com/IAM/latest/APIReference/API_DeactivateMFADevice.html\">DeactivateMFADevice</a>.</note>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=DeleteVirtualMFADevice\n&SerialNumber=arn:aws:iam::123456789012:mfa/ExampleName\n&Version=2010-05-08\n&AUTHPARAMS\n</queryrequest>\n\t\t\t<queryresponse>\n<DeleteVirtualMFADeviceResponse>\n <DeleteVirtualMFADeviceResult>\n <VirtualMFADevice>\n <SerialNumber>arn:aws:iam::123456789012:mfa/ExampleName</SerialNumber>\n </VirtualMFADevice>\n </DeleteVirtualMFADeviceResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</DeleteVirtualMFADeviceResponse>\n</queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"EnableMFADevice": {
|
||||
"name": "EnableMFADevice",
|
||||
|
|
@ -2163,7 +2221,7 @@
|
|||
"message": {
|
||||
"shape_name": "entityAlreadyExistsMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create a resource that already exists.</p>\n\t"
|
||||
|
|
@ -2175,7 +2233,7 @@
|
|||
"message": {
|
||||
"shape_name": "entityTemporarilyUnmodifiableMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that is temporarily unmodifiable,\n\t\t\tsuch as a user name that was deleted and then recreated. The error indicates that the request\n\t\t\tis likely to succeed if you try again after waiting several minutes. The error message\n\t\t\tdescribes the entity.</p>\n\t"
|
||||
|
|
@ -2187,7 +2245,7 @@
|
|||
"message": {
|
||||
"shape_name": "invalidAuthenticationCodeMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because the authentication code was not recognized. The error\n\t\t\tmessage describes the specific error.</p>\n\t"
|
||||
|
|
@ -2199,7 +2257,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -2211,7 +2269,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -2219,6 +2277,47 @@
|
|||
],
|
||||
"documentation": "\n\t\t<p>Enables the specified MFA device and associates it with the specified user name. When\n\t\t\tenabled, the MFA device is required for every subsequent login by the user name associated\n\t\t\twith the device.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=EnableMFADevice\n&UserName=Bob\n&SerialNumber=R1234\n&AuthenticationCode1=234567\n&AuthenticationCode2=987654\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<EnableMFADeviceResponse>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</EnableMFADeviceResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"GenerateCredentialReport": {
|
||||
"name": "GenerateCredentialReport",
|
||||
"input": null,
|
||||
"output": {
|
||||
"shape_name": "GenerateCredentialReportResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"State": {
|
||||
"shape_name": "ReportStateType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"STARTED",
|
||||
"INPROGRESS",
|
||||
"COMPLETE"
|
||||
],
|
||||
"documentation": "\n <p>Information about the state of a credential report.</p>\n "
|
||||
},
|
||||
"Description": {
|
||||
"shape_name": "ReportStateDescriptionType",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Information about the credential report.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Contains the result of a successful invocation of the <a>GenerateCredentialReport</a> action.</p> \n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "LimitExceededException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Generates a credential report for the AWS account. For more information about the credential report, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html\">Getting Credential Reports</a> in the <i>Using IAM</i> guide.</p>\n "
|
||||
},
|
||||
"GetAccountPasswordPolicy": {
|
||||
"name": "GetAccountPasswordPolicy",
|
||||
"input": null,
|
||||
|
|
@ -2260,17 +2359,34 @@
|
|||
"AllowUsersToChangePassword": {
|
||||
"shape_name": "booleanType",
|
||||
"type": "boolean",
|
||||
"documentation": "\n\t\t<p>Specifies whether to allow IAM users to change their own password.</p>\n\t"
|
||||
"documentation": "\n\t\t<p>Specifies whether IAM users are allowed to change their own password.</p>\n\t"
|
||||
},
|
||||
"ExpirePasswords": {
|
||||
"shape_name": "booleanType",
|
||||
"type": "boolean",
|
||||
"documentation": null
|
||||
"documentation": "\n <p>Specifies whether IAM users are required to change their password after a specified number of days.</p>\n "
|
||||
},
|
||||
"MaxPasswordAge": {
|
||||
"shape_name": "maxPasswordAgeType",
|
||||
"type": "integer",
|
||||
"documentation": null
|
||||
"min_length": 1,
|
||||
"max_length": 1095,
|
||||
"box": true,
|
||||
"documentation": "\n <p>The number of days that an IAM user password is valid.</p>\n "
|
||||
},
|
||||
"PasswordReusePrevention": {
|
||||
"shape_name": "passwordReusePreventionType",
|
||||
"type": "integer",
|
||||
"min_length": 1,
|
||||
"max_length": 24,
|
||||
"box": true,
|
||||
"documentation": "\n <p>Specifies the number of previous passwords that IAM users are prevented from reusing.</p>\n "
|
||||
},
|
||||
"HardExpiry": {
|
||||
"shape_name": "booleanObjectType",
|
||||
"type": "boolean",
|
||||
"box": true,
|
||||
"documentation": "\n <p>Specifies whether IAM users are prevented from setting a new password after their password has expired.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The PasswordPolicy data type contains information about the account password policy.</p>\n\t\t<p> This data type is used as a response element in the action <a>GetAccountPasswordPolicy</a>.\n\t\t</p>\n\t",
|
||||
|
|
@ -2287,13 +2403,13 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Retrieves the password policy for the AWS account. For more information about using a\n\t\t\tpassword policy, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html\">Managing an\n\t\t\t\tIAM Password Policy</a>.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=GetAccountPasswordPolicy\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<GetAccountPasswordPolicyResponse>\n <GetAccountPasswordPolicyResult>\n <PasswordPolicy> \n <MinimumPasswordLength>6</MinimumPasswordLength>, \n <RequireUppercaseCharacters>false</RequireUppercaseCharacters>\n <RequireLowercaseCharacters>false</RequireLowercaseCharacters> \n <RequireNumbers>false</RequireNumbers> \n <RequireSymbols>false</RequireSymbols>\n <AllowUsersToChangePassword>true</AllowUsersToChangePassword>\n </PasswordPolicy>\t\n </GetAccountPasswordPolicyResult>\n <ResponseMetadata> \n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</GetAccountPasswordPolicyResponse>\t\n</queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Retrieves the password policy for the AWS account. For more information about using a\n\t\t\tpassword policy, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html\">Managing an\n\t\t\t\tIAM Password Policy</a>.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=GetAccountPasswordPolicy\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<GetAccountPasswordPolicyResponse>\n <GetAccountPasswordPolicyResult>\n <PasswordPolicy>\n <MinimumPasswordLength>6</MinimumPasswordLength>,\n <RequireUppercaseCharacters>false</RequireUppercaseCharacters>\n <RequireLowercaseCharacters>false</RequireLowercaseCharacters>\n <RequireNumbers>false</RequireNumbers>\n <RequireSymbols>false</RequireSymbols>\n <AllowUsersToChangePassword>true</AllowUsersToChangePassword>\n </PasswordPolicy>\n </GetAccountPasswordPolicyResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</GetAccountPasswordPolicyResponse>\n</queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"GetAccountSummary": {
|
||||
"name": "GetAccountSummary",
|
||||
|
|
@ -2337,7 +2453,75 @@
|
|||
"documentation": "\n\t\t<p>Contains the result of a successful invocation of the <a>GetAccountSummary</a> action.</p>\n\t"
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "\n\t\t<p>Retrieves account level information about account entity usage and IAM quotas.</p>\n\t\t<p>For information about limitations on IAM entities, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?LimitationsOnEntities.html\" target=\"_blank\">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=GetAccountSummary\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<GetAccountSummaryResponse>\n <GetAccountSummaryResult>\n <SummaryMap>\n <entry>\n <key>Groups</key>\n <value>31</value>\n </entry>\n <entry>\n <key>GroupsQuota</key>\n <value>50</value>\n </entry>\n <entry>\n <key>UsersQuota</key>\n <value>150</value>\n </entry>\n <entry>\n <key>Users</key>\n <value>35</value>\n </entry>\n <entry>\n <key>GroupPolicySizeQuota</key>\n <value>10240</value>\n </entry>\n <entry>\n <key>AccessKeysPerUserQuota</key>\n <value>2</value>\n </entry>\n <entry>\n <key>GroupsPerUserQuota</key>\n <value>10</value>\n </entry>\n <entry>\n <key>UserPolicySizeQuota</key>\n <value>10240</value>\n </entry>\n <entry>\n <key>SigningCertificatesPerUserQuota</key>\n <value>2</value>\n </entry>\n <entry>\n <key>ServerCertificates</key>\n <value>0</value>\n </entry>\n <entry>\n <key>ServerCertificatesQuota</key>\n <value>10</value>\n </entry>\n <entry>\n <key>AccountMFAEnabled</key>\n <value>0</value>\n </entry>\n <entry>\n <key>MFADevicesInUse</key>\n <value>10</value>\n </entry>\n <entry>\n <key>MFADevices</key>\n <value>20</value>\n </entry>\n </SummaryMap>\n </GetAccountSummaryResult>\n <ResponseMetadata>\n <RequestId>f1e38443-f1ad-11df-b1ef-a9265EXAMPLE</RequestId>\n </ResponseMetadata>\n</GetAccountSummaryResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Retrieves account level information about account entity usage and IAM quotas.</p>\n\t\t<p>For information about limitations on IAM entities, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=GetAccountSummary\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<GetAccountSummaryResponse>\n <GetAccountSummaryResult>\n <SummaryMap>\n <entry>\n <key>Groups</key>\n <value>31</value>\n </entry>\n <entry>\n <key>GroupsQuota</key>\n <value>50</value>\n </entry>\n <entry>\n <key>UsersQuota</key>\n <value>150</value>\n </entry>\n <entry>\n <key>Users</key>\n <value>35</value>\n </entry>\n <entry>\n <key>GroupPolicySizeQuota</key>\n <value>10240</value>\n </entry>\n <entry>\n <key>AccessKeysPerUserQuota</key>\n <value>2</value>\n </entry>\n <entry>\n <key>GroupsPerUserQuota</key>\n <value>10</value>\n </entry>\n <entry>\n <key>UserPolicySizeQuota</key>\n <value>10240</value>\n </entry>\n <entry>\n <key>SigningCertificatesPerUserQuota</key>\n <value>2</value>\n </entry>\n <entry>\n <key>ServerCertificates</key>\n <value>0</value>\n </entry>\n <entry>\n <key>ServerCertificatesQuota</key>\n <value>10</value>\n </entry>\n <entry>\n <key>AccountMFAEnabled</key>\n <value>0</value>\n </entry>\n <entry>\n <key>MFADevicesInUse</key>\n <value>10</value>\n </entry>\n <entry>\n <key>MFADevices</key>\n <value>20</value>\n </entry>\n </SummaryMap>\n </GetAccountSummaryResult>\n <ResponseMetadata>\n <RequestId>f1e38443-f1ad-11df-b1ef-a9265EXAMPLE</RequestId>\n </ResponseMetadata>\n</GetAccountSummaryResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"GetCredentialReport": {
|
||||
"name": "GetCredentialReport",
|
||||
"input": null,
|
||||
"output": {
|
||||
"shape_name": "GetCredentialReportResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Content": {
|
||||
"shape_name": "ReportContentType",
|
||||
"type": "blob",
|
||||
"documentation": "\n <p>Contains the credential report. The report is Base64-encoded.</p>\n "
|
||||
},
|
||||
"ReportFormat": {
|
||||
"shape_name": "ReportFormatType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"text/csv"
|
||||
],
|
||||
"documentation": "\n <p>The format (MIME type) of the credential report.</p>\n "
|
||||
},
|
||||
"GeneratedTime": {
|
||||
"shape_name": "dateType",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The time and date when the credential report was created, in <a href=\"http://www.iso.org/iso/iso8601\">ISO 8601 date-time format</a>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Contains the result of a successful invocation of the <a>GetCredentialReport</a> action.</p> \n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "CredentialReportNotPresentException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "credentialReportNotPresentExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The request was rejected because the credential report does not exist. To generate a credential report, use <a>GenerateCredentialReport</a>.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CredentialReportExpiredException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "credentialReportExpiredExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The request was rejected because the most recent credential report has expired. To generate a new credential report, use <a>GenerateCredentialReport</a>. For more information about credential report expiration, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html\">Getting Credential Reports</a> in the <i>Using IAM</i> guide.</p> \n "
|
||||
},
|
||||
{
|
||||
"shape_name": "CredentialReportNotReadyException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "credentialReportNotReadyExceptionMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The request was rejected because the credential report is still being generated.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Retrieves a credential report for the AWS account. For more information about the credential report, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html\">Getting Credential Reports</a> in the <i>Using IAM</i> guide.</p>\n "
|
||||
},
|
||||
"GetGroup": {
|
||||
"name": "GetGroup",
|
||||
|
|
@ -2386,7 +2570,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the group. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the group. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"GroupName": {
|
||||
|
|
@ -2404,7 +2588,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the group. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the group. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -2412,7 +2596,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -2438,7 +2622,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the user. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the user. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"UserName": {
|
||||
|
|
@ -2456,7 +2640,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the user. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the user. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -2464,7 +2648,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -2503,19 +2687,22 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Returns a list of users that are in the specified group. You can paginate the results using\n\t\t\tthe <code>MaxItems</code> and <code>Marker</code> parameters.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=GetGroup\n&GroupName=Admins\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<GetGroupResponse>\n <GetGroupResult>\n <Group>\n <Path>/</Path>\n <GroupName>Admins</GroupName>\n <GroupId>AGPACKCEVSQ6C2EXAMPLE</GroupId>\n <Arn>arn:aws:iam::123456789012:group/Admins</Arn>\n </Group>\n <Users> \n <member>\n <Path>/division_abc/subdivision_xyz/</Path>\n <UserName>Bob</UserName>\n <UserId>AIDACKCEVSQ6C2EXAMPLE</UserId>\n <Arn>\n arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/Bob\n </Arn>\n </member>\n <member>\n <Path>/division_abc/subdivision_xyz/</Path>\n <UserName>Susan</UserName>\n <UserId>AIDACKCEVSQ6C2EXAMPLE</UserId>\n <Arn>\n arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/Susan\n </Arn>\n </member>\n </Users>\n <IsTruncated>false</IsTruncated>\n </GetGroupResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</GetGroupResponse>\n </queryresponse>\n\t\t</examples>\n\t",
|
||||
"documentation": "\n\t\t<p>Returns a list of users that are in the specified group. You can paginate the results using\n\t\t\tthe <code>MaxItems</code> and <code>Marker</code> parameters.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=GetGroup\n&GroupName=Admins\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<GetGroupResponse>\n <GetGroupResult>\n <Group>\n <Path>/</Path>\n <GroupName>Admins</GroupName>\n <GroupId>AGPACKCEVSQ6C2EXAMPLE</GroupId>\n <Arn>arn:aws:iam::123456789012:group/Admins</Arn>\n </Group>\n <Users>\n <member>\n <Path>/division_abc/subdivision_xyz/</Path>\n <UserName>Bob</UserName>\n <UserId>AIDACKCEVSQ6C2EXAMPLE</UserId>\n <Arn>\n arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/Bob\n </Arn>\n </member>\n <member>\n <Path>/division_abc/subdivision_xyz/</Path>\n <UserName>Susan</UserName>\n <UserId>AIDACKCEVSQ6C2EXAMPLE</UserId>\n <Arn>\n arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/Susan\n </Arn>\n </member>\n </Users>\n <IsTruncated>false</IsTruncated>\n </GetGroupResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</GetGroupResponse>\n </queryresponse>\n\t\t</examples>\n\t",
|
||||
"pagination": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"more_results": "IsTruncated",
|
||||
"limit_key": "MaxItems",
|
||||
"result_key": "Users",
|
||||
"non_aggregate_keys": [
|
||||
"Group"
|
||||
],
|
||||
"py_input_token": "marker"
|
||||
}
|
||||
},
|
||||
|
|
@ -2588,7 +2775,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -2628,7 +2815,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the instance profile. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the instance profile. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"InstanceProfileName": {
|
||||
|
|
@ -2646,7 +2833,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -2654,7 +2841,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -2676,7 +2863,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the role. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the role. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"RoleName": {
|
||||
|
|
@ -2694,7 +2881,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the role. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the role. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -2702,7 +2889,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -2740,7 +2927,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -2780,7 +2967,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 64,
|
||||
"pattern": "[\\w+=,.@-]*",
|
||||
"documentation": "\n\t\t<p>The name of the user, which can be used for signing into the AWS Management Console.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The name of the user, which can be used for signing in to the AWS Management Console.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -2788,6 +2975,11 @@
|
|||
"type": "timestamp",
|
||||
"documentation": "\n\t\t<p>The date when the password for the user was created.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"PasswordResetRequired": {
|
||||
"shape_name": "booleanType",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Specifies whether the user is required to set a new password on next sign-in.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>User name and password create date for the user.</p>\n\t",
|
||||
|
|
@ -2804,7 +2996,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -2844,7 +3036,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the role. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the role. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"RoleName": {
|
||||
|
|
@ -2862,7 +3054,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the role. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the role. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -2870,7 +3062,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -2902,13 +3094,13 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Retrieves information about the specified role, including the role's path, GUID, ARN, and the\n\t\t\tpolicy granting permission to EC2 to assume the role. For more information about ARNs, go to\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html#Identifiers_ARNs\">ARNs</a>. For more information about roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html\">Working with\n\t\t\tRoles</a>.</p>\n\t\t<p>The returned policy is URL-encoded according to RFC 3986. For more information about RFC\n\t\t\t3986, go to <a href=\"http://www.faqs.org/rfcs/rfc3986.html\">http://www.faqs.org/rfcs/rfc3986.html</a>.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=GetRole\n&RoleName=S3Access\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<GetRoleResponse xmlns=\"https://iam.amazonaws.com/doc/2010-05-08/\">\n <GetRoleResult>\n <Role>\n <Path>/application_abc/component_xyz/</Path>\n <Arn>arn:aws:iam::123456789012:role/application_abc/component_xyz/S3Access</Arn>\n <RoleName>S3Access</RoleName>\n <AssumeRolePolicyDocument>{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}</AssumeRolePolicyDocument>\n <CreateDate>2012-05-08T23:34:01Z</CreateDate>\n <RoleId>AROADBQP57FF2AEXAMPLE</RoleId>\n </Role>\n </GetRoleResult>\n <ResponseMetadata>\n <RequestId>df37e965-9967-11e1-a4c3-270EXAMPLE04</RequestId>\n </ResponseMetadata>\n</GetRoleResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Retrieves information about the specified role, including the role's path, GUID, ARN, and the\n\t\t\tpolicy granting permission to assume the role. For more information about ARNs, go to\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html#Identifiers_ARNs\">ARNs</a>. For more information about roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html\">Working with\n\t\t\tRoles</a>.</p>\n\t\t<p>The returned policy is URL-encoded according to RFC 3986. For more information about RFC\n\t\t\t3986, go to <a href=\"http://www.faqs.org/rfcs/rfc3986.html\">http://www.faqs.org/rfcs/rfc3986.html</a>.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=GetRole\n&RoleName=S3Access\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<GetRoleResponse xmlns=\"https://iam.amazonaws.com/doc/2010-05-08/\">\n <GetRoleResult>\n <Role>\n <Path>/application_abc/component_xyz/</Path>\n <Arn>arn:aws:iam::123456789012:role/application_abc/component_xyz/S3Access</Arn>\n <RoleName>S3Access</RoleName>\n <AssumeRolePolicyDocument>{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}</AssumeRolePolicyDocument>\n <CreateDate>2012-05-08T23:34:01Z</CreateDate>\n <RoleId>AROADBQP57FF2AEXAMPLE</RoleId>\n </Role>\n </GetRoleResult>\n <ResponseMetadata>\n <RequestId>df37e965-9967-11e1-a4c3-270EXAMPLE04</RequestId>\n </ResponseMetadata>\n</GetRoleResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"GetRolePolicy": {
|
||||
"name": "GetRolePolicy",
|
||||
|
|
@ -2979,7 +3171,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -3036,7 +3228,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -3054,7 +3246,7 @@
|
|||
"documentation": null
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Returns the SAML provider metadocument that was uploaded when the provider was created or\n\t\t\tupdated.</p>\n\t\t<note>This operation requires <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version\n\t\t\t4</a>.\n\t\t</note>\n\t\t\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=GetSAMLProvider\n&Name=arn:aws:iam::123456789012:saml-metadata/MyUniversity\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<GetSAMLProviderResponse xmlns=\"https://iam.amazonaws.com/doc/2010-05-08/\">\n <GetSAMLProviderResult>\n <CreateDate>2012-05-09T16:27:11Z</CreateDate>\n <ValidUntil>2015-12-31T211:59:59Z</ValidUntil>\n <SAMLMetadataDocument>Pd9fexDssTkRgGNqs...DxptfEs==</SAMLMetadataDocument>\n </GetSAMLProviderResult>\n <ResponseMetadata>\n <RequestId>29f47818-99f5-11e1-a4c3-27EXAMPLE804</RequestId>\n </ResponseMetadata>\n</GetSAMLProviderResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Returns the SAML provider metadocument that was uploaded when the provider was created or\n\t\t\tupdated.</p>\n\n\t\t<note>This operation requires <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version\n\t\t\t4</a>.\n\t\t</note>\n\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=GetSAMLProvider\n&Name=arn:aws:iam::123456789012:saml-metadata/MyUniversity\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<GetSAMLProviderResponse xmlns=\"https://iam.amazonaws.com/doc/2010-05-08/\">\n <GetSAMLProviderResult>\n <CreateDate>2012-05-09T16:27:11Z</CreateDate>\n <ValidUntil>2015-12-31T211:59:59Z</ValidUntil>\n <SAMLMetadataDocument>Pd9fexDssTkRgGNqs...DxptfEs==</SAMLMetadataDocument>\n </GetSAMLProviderResult>\n <ResponseMetadata>\n <RequestId>29f47818-99f5-11e1-a4c3-27EXAMPLE804</RequestId>\n </ResponseMetadata>\n</GetSAMLProviderResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"GetServerCertificate": {
|
||||
"name": "GetServerCertificate",
|
||||
|
|
@ -3092,7 +3284,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the server certificate. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the server certificate. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"ServerCertificateName": {
|
||||
|
|
@ -3110,7 +3302,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the server certificate. For more information about\n\t\t\tIDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the server certificate. For more information about\n\t\t\tIDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -3118,13 +3310,18 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the server certificate. For more information about\n\t\t\tARNs and how to use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the server certificate. For more information about\n\t\t\tARNs and how to use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"UploadDate": {
|
||||
"shape_name": "dateType",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n\t\t<p>The date when the server certificate was uploaded.</p>\n\t"
|
||||
"documentation": "\n\t\t<p>The date when the server certificate was uploaded.</p>\n "
|
||||
},
|
||||
"Expiration": {
|
||||
"shape_name": "dateType",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date on which the certificate is set to expire.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The meta information of the server certificate, such as its name, path, ID, and ARN.</p>\n\t",
|
||||
|
|
@ -3162,13 +3359,13 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Retrieves information about the specified server certificate.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=GetServerCertificate\n&ServerCertificateName=ProdServerCert\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<GetServerCertificateResponse>\n <GetServerCertificateResult>\n <ServerCertificate>\n <ServerCertificateMetadata>\n <ServerCertificateName>ProdServerCert</ServerCertificateName>\n <Path>/company/servercerts/</Path>\n <Arn>arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert</Arn>\n <UploadDate>2010-05-08T01:02:03.004Z</UploadDate>\n <ServerCertificateId>ASCACKCEVSQ6C2EXAMPLE</ServerCertificateId>\n </ServerCertificateMetadata>\n <CertificateBody>-----BEGIN CERTIFICATE-----\nMIICdzCCAeCgAwIBAgIGANc+Ha2wMA0GCSqGSIb3DQEBBQUAMFMxCzAJBgNVBAYT\nAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMQwwCgYDVQQLEwNBV1MxITAfBgNVBAMT\nGEFXUyBMaW1pdGVkLUFzc3VyYW5jZSBDQTAeFw0wOTAyMDQxNzE5MjdaFw0xMDAy\nMDQxNzE5MjdaMFIxCzAJBgNVBAYTAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMRcw\nFQYDVQQLEw5BV1MtRGV2ZWxvcGVyczEVMBMGA1UEAxMMNTdxNDl0c3ZwYjRtMIGf\nMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCpB/vsOwmT/O0td1RqzKjttSBaPjbr\ndqwNe9BrOyB08fw2+Ch5oonZYXfGUrT6mkYXH5fQot9HvASrzAKHO596FdJA6DmL\nywdWe1Oggk7zFSXO1Xv+3vPrJtaYxYo3eRIp7w80PMkiOv6M0XK8ubcTouODeJbf\nsuDqcLnLDxwsvwIDAQABo1cwVTAOBgNVHQ8BAf8EBAMCBaAwFgYDVR0lAQH/BAww\nCgYIKwYBBQUHAwIwDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQULGNaBphBumaKbDRK\nCAi0mH8B3mowDQYJKoZIhvcNAQEFBQADgYEAuKxhkXaCLGcqDuweKtO/AEw9ZePH\nwr0XqsaIK2HZboqruebXEGsojK4Ks0WzwgrEynuHJwTn760xe39rSqXWIOGrOBaX\nwFpWHVjTFMKk+tSDG1lssLHyYWWdFFU4AnejRGORJYNaRHgVTKjHphc5jEhHm0BX\nAEaHzTpmEXAMPLE=\n-----END CERTIFICATE-----\n </CertificateBody>\n </ServerCertificate>\n </GetServerCertificateResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</GetServerCertificateResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Retrieves information about the specified server certificate.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=GetServerCertificate\n&ServerCertificateName=ProdServerCert\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<GetServerCertificateResponse>\n <GetServerCertificateResult>\n <ServerCertificate>\n <ServerCertificateMetadata>\n <ServerCertificateName>ProdServerCert</ServerCertificateName>\n <Path>/company/servercerts/</Path>\n <Arn>arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert</Arn>\n <UploadDate>2010-05-08T01:02:03.004Z</UploadDate>\n <ServerCertificateId>ASCACKCEVSQ6C2EXAMPLE</ServerCertificateId>\n <Expiration>2012-05-08T01:02:03.004Z</Expiration>\n </ServerCertificateMetadata>\n <CertificateBody>-----BEGIN CERTIFICATE-----\nMIICdzCCAeCgAwIBAgIGANc+Ha2wMA0GCSqGSIb3DQEBBQUAMFMxCzAJBgNVBAYT\nAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMQwwCgYDVQQLEwNBV1MxITAfBgNVBAMT\nGEFXUyBMaW1pdGVkLUFzc3VyYW5jZSBDQTAeFw0wOTAyMDQxNzE5MjdaFw0xMDAy\nMDQxNzE5MjdaMFIxCzAJBgNVBAYTAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMRcw\nFQYDVQQLEw5BV1MtRGV2ZWxvcGVyczEVMBMGA1UEAxMMNTdxNDl0c3ZwYjRtMIGf\nMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCpB/vsOwmT/O0td1RqzKjttSBaPjbr\ndqwNe9BrOyB08fw2+Ch5oonZYXfGUrT6mkYXH5fQot9HvASrzAKHO596FdJA6DmL\nywdWe1Oggk7zFSXO1Xv+3vPrJtaYxYo3eRIp7w80PMkiOv6M0XK8ubcTouODeJbf\nsuDqcLnLDxwsvwIDAQABo1cwVTAOBgNVHQ8BAf8EBAMCBaAwFgYDVR0lAQH/BAww\nCgYIKwYBBQUHAwIwDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQULGNaBphBumaKbDRK\nCAi0mH8B3mowDQYJKoZIhvcNAQEFBQADgYEAuKxhkXaCLGcqDuweKtO/AEw9ZePH\nwr0XqsaIK2HZboqruebXEGsojK4Ks0WzwgrEynuHJwTn760xe39rSqXWIOGrOBaX\nwFpWHVjTFMKk+tSDG1lssLHyYWWdFFU4AnejRGORJYNaRHgVTKjHphc5jEhHm0BX\nAEaHzTpmEXAMPLE=\n-----END CERTIFICATE-----\n </CertificateBody>\n </ServerCertificate>\n </GetServerCertificateResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</GetServerCertificateResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"GetUser": {
|
||||
"name": "GetUser",
|
||||
|
|
@ -3201,7 +3398,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the user. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the user. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"UserName": {
|
||||
|
|
@ -3219,7 +3416,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the user. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the user. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -3227,7 +3424,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -3251,7 +3448,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -3328,7 +3525,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -3439,13 +3636,13 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Returns information about the access key IDs associated with the specified user. If there are\n\t\t\tnone, the action returns an empty list.</p>\n\t\t<p>Although each user is limited to a small number of keys, you can still paginate the results\n\t\t\tusing the <code>MaxItems</code> and <code>Marker</code> parameters.</p>\n\t\t<p>If the <code>UserName</code> field is not specified, the UserName is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.</p>\n\t\t<note>To ensure the security of your AWS account, the secret access key is accessible only\n\t\t\tduring key and user creation.</note>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=ListAccessKeys\n&UserName=Bob\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<ListAccessKeysResponse>\n <ListAccessKeysResult>\n <UserName>Bob</UserName>\n <AccessKeyMetadata>\n <member>\n <UserName>Bob</UserName>\n <AccessKeyId>AKIAIOSFODNN7EXAMPLE</AccessKeyId>\n <Status>Active</Status>\n </member>\n <member>\n <UserName>Bob</UserName>\n <AccessKeyId>AKIAI44QH8DHBEXAMPLE</AccessKeyId>\n <Status>Inactive</Status>\n </member>\n </AccessKeyMetadata>\n <IsTruncated>false</IsTruncated>\n </ListAccessKeysResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</ListAccessKeysResponse>\n </queryresponse>\n\t\t</examples>\n\t",
|
||||
"documentation": "\n\t\t<p>Returns information about the access key IDs associated with the specified user. If there are\n\t\t\tnone, the action returns an empty list.</p>\n\t\t<p>Although each user is limited to a small number of keys, you can still paginate the results\n\t\t\tusing the <code>MaxItems</code> and <code>Marker</code> parameters.</p>\n\t\t<p>If the <code>UserName</code> field is not specified, the UserName is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.</p>\n\n\t\t<note>To ensure the security of your AWS account, the secret access key is accessible only\n\t\t\tduring key and user creation.</note>\n\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=ListAccessKeys\n&UserName=Bob\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<ListAccessKeysResponse>\n <ListAccessKeysResult>\n <UserName>Bob</UserName>\n <AccessKeyMetadata>\n <member>\n <UserName>Bob</UserName>\n <AccessKeyId>AKIAIOSFODNN7EXAMPLE</AccessKeyId>\n <Status>Active</Status>\n </member>\n <member>\n <UserName>Bob</UserName>\n <AccessKeyId>AKIAI44QH8DHBEXAMPLE</AccessKeyId>\n <Status>Inactive</Status>\n </member>\n </AccessKeyMetadata>\n <IsTruncated>false</IsTruncated>\n </ListAccessKeysResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</ListAccessKeysResponse>\n </queryresponse>\n\t\t</examples>\n\t",
|
||||
"pagination": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
|
|
@ -3514,7 +3711,7 @@
|
|||
"documentation": "\n\t\t<p>Contains the result of a successful invocation of the <a>ListAccountAliases</a> action.</p>\n\t"
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "\n\t\t<p>Lists the account aliases associated with the account. For information about using an AWS\n\t\t\taccount alias, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html\" target=\"_blank\">Using an Alias for Your AWS Account ID</a> in <i>Using AWS Identity and\n\t\t\t\tAccess Management</i>.</p>\n\t\t<p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>\n\t\t\tparameters.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=ListAccountAliases\n&Version=2010-05-08\n&AUTHPARAMS \n </queryrequest>\n\t\t\t<queryresponse>\n<ListAccountAliasesResponse>\n <ListAccountAliasesResult>\n <IsTruncated>false</IsTruncated>\n <AccountAliases>\n <member>foocorporation</member>\n </AccountAliases>\n </ListAccountAliasesResult>\n <ResponseMetadata>\n <RequestId>c5a076e9-f1b0-11df-8fbe-45274EXAMPLE</RequestId>\n </ResponseMetadata>\n</ListAccountAliasesResponse>\n </queryresponse>\n\t\t</examples>\n\t",
|
||||
"documentation": "\n\t\t<p>Lists the account aliases associated with the account. For information about using an AWS\n\t\t\taccount alias, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html\">Using an Alias for Your AWS Account ID</a> in the <i>Using IAM</i> guide.</p>\n\t\t<p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>\n\t\t\tparameters.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=ListAccountAliases\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<ListAccountAliasesResponse>\n <ListAccountAliasesResult>\n <IsTruncated>false</IsTruncated>\n <AccountAliases>\n <member>foocorporation</member>\n </AccountAliases>\n </ListAccountAliasesResult>\n <ResponseMetadata>\n <RequestId>c5a076e9-f1b0-11df-8fbe-45274EXAMPLE</RequestId>\n </ResponseMetadata>\n</ListAccountAliasesResponse>\n </queryresponse>\n\t\t</examples>\n\t",
|
||||
"pagination": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
|
|
@ -3599,7 +3796,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -3664,7 +3861,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the group. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the group. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"GroupName": {
|
||||
|
|
@ -3682,7 +3879,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the group. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the group. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -3690,7 +3887,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -3782,7 +3979,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the group. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the group. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"GroupName": {
|
||||
|
|
@ -3800,7 +3997,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the group. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the group. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -3808,7 +4005,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -3847,13 +4044,13 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Lists the groups the specified user belongs to.</p>\n\t\t<p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>\n\t\t\tparameters.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\n\t\t\t\t\nhttps://iam.amazonaws.com/\n?Action=ListGroupsForUser\n&UserName=Bob\n&AUTHPARAMS\n \n\t\t\t</queryrequest>\n\t\t\t<queryresponse>\n\t\t\t\t\n<ListGroupsForUserResponse> \n <ListGroupsForUserResult>\n <Groups>\n <member>\n <Path>/</Path>\n <GroupName>Admins</GroupName>\n <GroupId>AGPACKCEVSQ6C2EXAMPLE</GroupId>\n <Arn>arn:aws:iam::123456789012:group/Admins</Arn>\n </member>\n </Groups>\n <IsTruncated>false</IsTruncated>\n </ListGroupsForUserResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</ListGroupsForUserResponse>\n</queryresponse>\n\t\t</examples>\n\t",
|
||||
"documentation": "\n\t\t<p>Lists the groups the specified user belongs to.</p>\n\t\t<p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>\n\t\t\tparameters.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\n\t\t\t\t\nhttps://iam.amazonaws.com/\n?Action=ListGroupsForUser\n&UserName=Bob\n&AUTHPARAMS\n \n\t\t\t</queryrequest>\n\t\t\t<queryresponse>\n\t\t\t\t\n<ListGroupsForUserResponse>\n <ListGroupsForUserResult>\n <Groups>\n <member>\n <Path>/</Path>\n <GroupName>Admins</GroupName>\n <GroupId>AGPACKCEVSQ6C2EXAMPLE</GroupId>\n <Arn>arn:aws:iam::123456789012:group/Admins</Arn>\n </member>\n </Groups>\n <IsTruncated>false</IsTruncated>\n </ListGroupsForUserResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</ListGroupsForUserResponse>\n</queryresponse>\n\t\t</examples>\n\t",
|
||||
"pagination": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
|
|
@ -3912,7 +4109,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the instance profile. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the instance profile. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"InstanceProfileName": {
|
||||
|
|
@ -3930,7 +4127,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -3938,7 +4135,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -3960,7 +4157,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the role. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the role. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"RoleName": {
|
||||
|
|
@ -3978,7 +4175,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the role. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the role. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -3986,7 +4183,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -4073,7 +4270,7 @@
|
|||
"documentation": "\n\t\t<p>Use this parameter only when paginating results to indicate the maximum number of user names\n\t\t\tyou want in the response. If there are additional user names beyond the maximum you specify,\n\t\t\tthe <code>IsTruncated</code> response element is <code>true</code>. This parameter is\n\t\t\toptional. If you do not include it, it defaults to 100.</p>\n\t"
|
||||
}
|
||||
},
|
||||
"documentation": null
|
||||
"documentation": " "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ListInstanceProfilesForRoleResponse",
|
||||
|
|
@ -4092,7 +4289,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the instance profile. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the instance profile. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"InstanceProfileName": {
|
||||
|
|
@ -4110,7 +4307,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -4118,7 +4315,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -4140,7 +4337,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the role. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the role. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"RoleName": {
|
||||
|
|
@ -4158,7 +4355,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the role. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the role. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -4166,7 +4363,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -4219,7 +4416,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -4332,7 +4529,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -4423,7 +4620,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -4488,7 +4685,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the role. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the role. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"RoleName": {
|
||||
|
|
@ -4506,7 +4703,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the role. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the role. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -4514,7 +4711,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -4609,7 +4806,7 @@
|
|||
"documentation": "\n\t\t<p>Contains the result of a successful invocation of the <a>ListSAMLProviders</a> action.</p>\n\t"
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "\n\t\t<p>Lists the SAML providers in the account.</p>\n\t\t<note>This operation requires <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version\n\t\t\t4</a>.</note>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=ListSAMLProviders\n&MaxItems=100\n&PathPrefix=/application_abc/\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<ListSAMLProvidersResponse xmlns=\"https://iam.amazonaws.com/doc/2010-05-08/\">\n <ListSAMLProvidersResult>\n <SAMLProviderList>\n <member>\n <Arn>arn:aws:iam::123456789012:instance-profile/application_abc/component_xyz/Database</Arn>\n <ValidUntil>2032-05-09T16:27:11Z</ValidUntil>\n <CreateDate>2012-05-09T16:27:03Z</CreateDate>\n </member>\n <member>\n <Arn>arn:aws:iam::123456789012:instance-profile/application_abc/component_xyz/Webserver</Arn>\n <ValidUntil>2015-03-11T13:11:02Z</ValidUntil>\n <CreateDate>2012-05-09T16:27:11Z</CreateDate>\n </member>\n </SAMLProviderList>\n </ListSAMLProvidersResult>\n <ResponseMetadata>\n <RequestId>fd74fa8d-99f3-11e1-a4c3-27EXAMPLE804</RequestId>\n </ResponseMetadata>\n</ListInstanceProfilesResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Lists the SAML providers in the account.</p>\n\n\t\t<note>This operation requires <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version\n\t\t\t4</a>.</note>\n\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=ListSAMLProviders\n&MaxItems=100\n&PathPrefix=/application_abc/\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<ListSAMLProvidersResponse xmlns=\"https://iam.amazonaws.com/doc/2010-05-08/\">\n <ListSAMLProvidersResult>\n <SAMLProviderList>\n <member>\n <Arn>arn:aws:iam::123456789012:instance-profile/application_abc/component_xyz/Database</Arn>\n <ValidUntil>2032-05-09T16:27:11Z</ValidUntil>\n <CreateDate>2012-05-09T16:27:03Z</CreateDate>\n </member>\n <member>\n <Arn>arn:aws:iam::123456789012:instance-profile/application_abc/component_xyz/Webserver</Arn>\n <ValidUntil>2015-03-11T13:11:02Z</ValidUntil>\n <CreateDate>2012-05-09T16:27:11Z</CreateDate>\n </member>\n </SAMLProviderList>\n </ListSAMLProvidersResult>\n <ResponseMetadata>\n <RequestId>fd74fa8d-99f3-11e1-a4c3-27EXAMPLE804</RequestId>\n </ResponseMetadata>\n</ListSAMLProvidersResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"ListServerCertificates": {
|
||||
"name": "ListServerCertificates",
|
||||
|
|
@ -4660,7 +4857,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the server certificate. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the server certificate. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"ServerCertificateName": {
|
||||
|
|
@ -4678,7 +4875,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the server certificate. For more information about\n\t\t\tIDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the server certificate. For more information about\n\t\t\tIDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -4686,13 +4883,18 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the server certificate. For more information about\n\t\t\tARNs and how to use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the server certificate. For more information about\n\t\t\tARNs and how to use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"UploadDate": {
|
||||
"shape_name": "dateType",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n\t\t<p>The date when the server certificate was uploaded.</p>\n\t"
|
||||
"documentation": "\n\t\t<p>The date when the server certificate was uploaded.</p>\n "
|
||||
},
|
||||
"Expiration": {
|
||||
"shape_name": "dateType",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date on which the certificate is set to expire.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>ServerCertificateMetadata contains information about a server certificate without its\n\t\t\tcertificate body, certificate chain, and private key.</p>\n\t\t<p>This data type is used as a response element in the action <a>UploadServerCertificate</a> and\n\t\t\t\t<a>ListServerCertificates</a>.</p>\n\t"
|
||||
|
|
@ -4717,7 +4919,7 @@
|
|||
"documentation": "\n\t\t<p>Contains the result of a successful invocation of the <a>ListServerCertificates</a>\n\t\t\taction.</p>\n\t"
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "\n\t\t<p>Lists the server certificates that have the specified path prefix. If none exist, the action\n\t\t\treturns an empty list.</p>\n\t\t<p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>\n\t\t\tparameters.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=ListServerCertificates\n&PathPrefix=/company/servercerts\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<ListServerCertificatesResponse>\n <ListServerCertificatesResult>\n <IsTruncated>false</IsTruncated>\n <ServerCertificateMetadataList>\n <member>\n <ServerCertificateMetadata>\n <ServerCertificateName>ProdServerCert</ServerCertificateName>\n <Path>/company/servercerts/</Path>\n <Arn>arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert</Arn>\n <UploadDate>2010-05-08T01:02:03.004Z</UploadDate>\n <ServerCertificateId>ASCACKCEVSQ6CEXAMPLE1</ServerCertificateId>\n </ServerCertificateMetadata>\n </member>\n <member>\n <ServerCertificateMetadata>\n <ServerCertificateName>BetaServerCert</ServerCertificateName>\n <Path>/company/servercerts/</Path>\n <Arn>arn:aws:iam::123456789012:server-certificate/company/servercerts/BetaServerCert</Arn>\n <UploadDate>2010-05-08T02:03:01.004Z</UploadDate>\n <ServerCertificateId>ASCACKCEVSQ6CEXAMPLE2</ServerCertificateId>\n </ServerCertificateMetadata>\n </member>\n <member>\n <ServerCertificateMetadata>\n <ServerCertificateName>TestServerCert</ServerCertificateName>\n <Path>/company/servercerts/</Path>\n <Arn>arn:aws:iam::123456789012:server-certificate/company/servercerts/TestServerCert</Arn>\n <UploadDate>2010-05-08T03:01:02.004Z</UploadDate>\n <ServerCertificateId>ASCACKCEVSQ6CEXAMPLE3</ServerCertificateId>\n </ServerCertificateMetadata>\n </member>\n </ServerCertificateMetadataList>\n </ListServerCertificatesResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</ListServerCertificatesResponse>\n </queryresponse>\n\t\t</examples>\n\t",
|
||||
"documentation": "\n\t\t<p>Lists the server certificates that have the specified path prefix. If none exist, the action\n\t\t\treturns an empty list.</p>\n\t\t<p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>\n\t\t\tparameters.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=ListServerCertificates\n&PathPrefix=/company/servercerts\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<ListServerCertificatesResponse>\n <ListServerCertificatesResult>\n <IsTruncated>false</IsTruncated>\n <ServerCertificateMetadataList>\n <member>\n <ServerCertificateMetadata>\n <ServerCertificateName>ProdServerCert</ServerCertificateName>\n <Path>/company/servercerts/</Path>\n <Arn>arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert</Arn>\n <UploadDate>2010-05-08T01:02:03.004Z</UploadDate>\n <ServerCertificateId>ASCACKCEVSQ6CEXAMPLE1</ServerCertificateId>\n <Expiration>2012-05-08T01:02:03.004Z</Expiration>\n </ServerCertificateMetadata>\n </member>\n <member>\n <ServerCertificateMetadata>\n <ServerCertificateName>BetaServerCert</ServerCertificateName>\n <Path>/company/servercerts/</Path>\n <Arn>arn:aws:iam::123456789012:server-certificate/company/servercerts/BetaServerCert</Arn>\n <UploadDate>2010-05-08T02:03:01.004Z</UploadDate>\n <ServerCertificateId>ASCACKCEVSQ6CEXAMPLE2</ServerCertificateId>\n <Expiration>2012-05-08T02:03:01.004Z</Expiration>\n </ServerCertificateMetadata>\n </member>\n <member>\n <ServerCertificateMetadata>\n <ServerCertificateName>TestServerCert</ServerCertificateName>\n <Path>/company/servercerts/</Path>\n <Arn>arn:aws:iam::123456789012:server-certificate/company/servercerts/TestServerCert</Arn>\n <UploadDate>2010-05-08T03:01:02.004Z</UploadDate>\n <ServerCertificateId>ASCACKCEVSQ6CEXAMPLE3</ServerCertificateId>\n <Expiration>2012-05-08T03:01:02.004Z</Expiration>\n </ServerCertificateMetadata>\n </member>\n </ServerCertificateMetadataList>\n </ListServerCertificatesResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</ListServerCertificatesResponse>\n </queryresponse>\n\t\t</examples>\n\t",
|
||||
"pagination": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
|
|
@ -4842,7 +5044,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -4933,7 +5135,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -4998,7 +5200,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the user. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the user. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"UserName": {
|
||||
|
|
@ -5016,7 +5218,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the user. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the user. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -5024,7 +5226,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -5098,7 +5300,7 @@
|
|||
"documentation": "\n\t\t<p>Use this parameter only when paginating results to indicate the maximum number of user names\n\t\t\tyou want in the response. If there are additional user names beyond the maximum you specify,\n\t\t\tthe <code>IsTruncated</code> response element is <code>true</code>. This parameter is\n\t\t\toptional. If you do not include it, it defaults to 100.</p>\n\t"
|
||||
}
|
||||
},
|
||||
"documentation": null
|
||||
"documentation": " "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ListVirtualMFADevicesResponse",
|
||||
|
|
@ -5124,7 +5326,7 @@
|
|||
"shape_name": "BootstrapDatum",
|
||||
"type": "blob",
|
||||
"sensitive": true,
|
||||
"documentation": "\n\t\t<p>The Base32 seed defined as specified in <a href=\"http://www.ietf.org/rfc/rfc3548.txt\" target=\"_blank\">RFC3548</a>. The <code>Base32StringSeed</code> is Base64-encoded.</p>\n\t"
|
||||
"documentation": "\n\t\t<p>The Base32 seed defined as specified in <a href=\"http://www.ietf.org/rfc/rfc3548.txt\">RFC3548</a>. The <code>Base32StringSeed</code> is Base64-encoded.</p>\n\t"
|
||||
},
|
||||
"QRCodePNG": {
|
||||
"shape_name": "BootstrapDatum",
|
||||
|
|
@ -5142,7 +5344,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the user. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the user. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"UserName": {
|
||||
|
|
@ -5160,7 +5362,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the user. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the user. For more information about IDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -5168,7 +5370,7 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"CreateDate": {
|
||||
|
|
@ -5208,7 +5410,7 @@
|
|||
"documentation": "\n\t\t<p>Contains the result of a successful invocation of the <a>ListVirtualMFADevices</a>\n\t\t\taction.</p>\n\t"
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "\n\t\t<p> Lists the virtual MFA devices under the AWS account by assignment status. If you do not\n\t\t\tspecify an assignment status, the action returns a list of all virtual MFA devices. Assignment\n\t\t\tstatus can be <code>Assigned</code>, <code>Unassigned</code>, or <code>Any</code>. </p>\n\t\t<p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>\n\t\t\tparameters.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\n<!-- This example shows the request where \n the AssignmentStatus is Any -->\n \nhttps://iam.amazonaws.com/\n?Action=ListVirtualMFADevices\n&AssignmentStatus=Any\n&AUTHPARAMS\n</queryrequest>\n\t\t\t<queryresponse>\n<!-- The action returns all three virtual MFA devices\n associated with the account: the first device is\n unassigned, the second is assigned to the root \n account, and the third is assigned to a user \n named ExampleUser under the account. -->\n\n<ListVirtualMFADevicesResponse>\n <ListVirtualMFADevicesResult>\n <IsTruncated>false</IsTruncated>\n <VirtualMFADevices>\n <member>\n <SerialNumber>\n arn:aws:iam::123456789012:mfa/MFAdeviceName\n </SerialNumber>\n </member>\n <member>\n <SerialNumber>\n arn:aws:iam::123456789012:mfa/RootMFAdeviceName\n </SerialNumber>\n <EnableDate>2011-10-20T20:49:03Z</EnableDate>\n <User>\n <UserId>123456789012</UserId>\n <Arn>arn:aws:iam::123456789012:root</Arn>\n <CreateDate>2009-10-13T22:00:36Z</CreateDate>\n </User>\n </member>\n <member>\n <SerialNumber>\n arn:aws:iam:::mfa/ExampleUserMFAdeviceName\n </SerialNumber>\n <EnableDate>2011-10-31T20:45:02Z</EnableDate>\n <User>\n <UserId>AIDEXAMPLE4EXAMPLEXYZ</UserId>\n <Path>/</Path>\n <UserName>ExampleUser</UserName>\n <Arn>arn:aws:iam::111122223333:user/ExampleUser</Arn>\n <CreateDate>2011-07-01T17:23:07Z</CreateDate>\n </User>\n </member>\n </VirtualMFADevices>\n </ListVirtualMFADevicesResult>\n <ResponseMetadata>\n <RequestId>b61ce1b1-0401-11e1-b2f8-2dEXAMPLEbfc</RequestId>\n </ResponseMetadata>\n</ListVirtualMFADevicesResponse>\n</queryresponse>\n\t\t</examples>\n\t",
|
||||
"documentation": "\n\t\t<p> Lists the virtual MFA devices under the AWS account by assignment status. If you do not\n\t\t\tspecify an assignment status, the action returns a list of all virtual MFA devices. Assignment\n\t\t\tstatus can be <code>Assigned</code>, <code>Unassigned</code>, or <code>Any</code>. </p>\n\t\t<p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code>\n\t\t\tparameters.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\n<!-- This example shows the request where\n the AssignmentStatus is Any -->\n\nhttps://iam.amazonaws.com/\n?Action=ListVirtualMFADevices\n&AssignmentStatus=Any\n&AUTHPARAMS\n</queryrequest>\n\t\t\t<queryresponse>\n<!-- The action returns all three virtual MFA devices\n associated with the account: the first device is\n unassigned, the second is assigned to the root\n account, and the third is assigned to a user\n named ExampleUser under the account. -->\n\n<ListVirtualMFADevicesResponse>\n <ListVirtualMFADevicesResult>\n <IsTruncated>false</IsTruncated>\n <VirtualMFADevices>\n <member>\n <SerialNumber>\n arn:aws:iam::123456789012:mfa/MFAdeviceName\n </SerialNumber>\n </member>\n <member>\n <SerialNumber>\n arn:aws:iam::123456789012:mfa/RootMFAdeviceName\n </SerialNumber>\n <EnableDate>2011-10-20T20:49:03Z</EnableDate>\n <User>\n <UserId>123456789012</UserId>\n <Arn>arn:aws:iam::123456789012:root</Arn>\n <CreateDate>2009-10-13T22:00:36Z</CreateDate>\n </User>\n </member>\n <member>\n <SerialNumber>\n arn:aws:iam:::mfa/ExampleUserMFAdeviceName\n </SerialNumber>\n <EnableDate>2011-10-31T20:45:02Z</EnableDate>\n <User>\n <UserId>AIDEXAMPLE4EXAMPLEXYZ</UserId>\n <Path>/</Path>\n <UserName>ExampleUser</UserName>\n <Arn>arn:aws:iam::111122223333:user/ExampleUser</Arn>\n <CreateDate>2011-07-01T17:23:07Z</CreateDate>\n </User>\n </member>\n </VirtualMFADevices>\n </ListVirtualMFADevicesResult>\n <ResponseMetadata>\n <RequestId>b61ce1b1-0401-11e1-b2f8-2dEXAMPLEbfc</RequestId>\n </ResponseMetadata>\n</ListVirtualMFADevicesResponse>\n</queryresponse>\n\t\t</examples>\n\t",
|
||||
"pagination": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
|
|
@ -5263,7 +5465,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -5275,7 +5477,7 @@
|
|||
"message": {
|
||||
"shape_name": "malformedPolicyDocumentMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.</p>\n\t"
|
||||
|
|
@ -5287,13 +5489,13 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Adds (or updates) a policy document associated with the specified group. For information\n\t\t\tabout policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?PoliciesOverview.html\" target=\"_blank\">Overview of Policies</a> in <i>Using AWS Identity and Access Management</i>.</p>\n\t\t<p>For information about limits on the number of policies you can associate with a group, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?LimitationsOnEntities.html\" target=\"_blank\">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<note>Because policy documents can be large, you should use POST rather than GET when calling\n\t\t\t\t<code>PutGroupPolicy</code>. For information about setting up signatures and authorization\n\t\t\tthrough the API, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html\" target=\"_blank\">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information\n\t\t\tabout using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\" target=\"_blank\">Making\n\t\t\t\tQuery Requests</a> in <i>Using IAM</i>.</note>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=PutGroupPolicy\n&GroupName=Admins\n&PolicyName=AdminRoot\n&PolicyDocument={\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}]}\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<PutGroupPolicyResponse>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</PutGroupPolicyResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Adds (or updates) a policy document associated with the specified group. For information\n\t\t\tabout policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html\">Overview of Policies</a> in the <i>Using IAM</i> guide.</p>\n\t\t<p>For information about limits on the number of policies you can associate with a group, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\n\t\t<note>Because policy documents can be large, you should use POST rather than GET when calling\n\t\t\t\t<code>PutGroupPolicy</code>. For information about setting up signatures and authorization\n\t\t\tthrough the API, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html\">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information\n\t\t\tabout using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\">Making\n\t\t\t\tQuery Requests</a> in the <i>Using IAM</i> guide.</note>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=PutGroupPolicy\n&GroupName=Admins\n&PolicyName=AdminRoot\n&PolicyDocument={\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}]}\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<PutGroupPolicyResponse>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</PutGroupPolicyResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"PutRolePolicy": {
|
||||
"name": "PutRolePolicy",
|
||||
|
|
@ -5340,7 +5542,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -5352,7 +5554,7 @@
|
|||
"message": {
|
||||
"shape_name": "malformedPolicyDocumentMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.</p>\n\t"
|
||||
|
|
@ -5364,13 +5566,13 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Adds (or updates) a policy document associated with the specified role. For information about\n\t\t\tpolicies, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?PoliciesOverview.html\" target=\"_blank\">Overview of Policies</a> in <i>Using AWS Identity and Access Management</i>.</p>\n\t\t<p>For information about limits on the policies you can associate with a role, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?LimitationsOnEntities.html\" target=\"_blank\">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<note>Because policy documents can be large, you should use POST rather than GET when calling\n\t\t\t\t<code>PutRolePolicy</code>. For information about setting up signatures and authorization\n\t\t\tthrough the API, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html\" target=\"_blank\">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information\n\t\t\tabout using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\" target=\"_blank\">Making\n\t\t\t\tQuery Requests</a> in <i>Using IAM</i>.</note>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=PutRolePolicy\n&RoleName=S3Access\n&PolicyName=S3AccessPolicy\n&PolicyDocument={\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}]}\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<PutRolePolicyResponse>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</PutRolePolicyResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Adds (or updates) a policy document associated with the specified role. For information about\n\t\t\tpolicies, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html\">Overview of Policies</a> in the <i>Using IAM</i> guide.</p>\n\t\t<p>For information about limits on the policies you can associate with a role, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\n\t\t<note>Because policy documents can be large, you should use POST rather than GET when calling\n\t\t\t\t<code>PutRolePolicy</code>. For information about setting up signatures and authorization\n\t\t\tthrough the API, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html\">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information\n\t\t\tabout using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\">Making\n\t\t\t\tQuery Requests</a> in the <i>Using IAM</i> guide.</note>\n\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=PutRolePolicy\n&RoleName=S3Access\n&PolicyName=S3AccessPolicy\n&PolicyDocument={\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}]}\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<PutRolePolicyResponse>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</PutRolePolicyResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"PutUserPolicy": {
|
||||
"name": "PutUserPolicy",
|
||||
|
|
@ -5417,7 +5619,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -5429,7 +5631,7 @@
|
|||
"message": {
|
||||
"shape_name": "malformedPolicyDocumentMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.</p>\n\t"
|
||||
|
|
@ -5441,13 +5643,13 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Adds (or updates) a policy document associated with the specified user. For information about\n\t\t\tpolicies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?PoliciesOverview.html\" target=\"_blank\">Overview of Policies</a> in <i>Using AWS Identity and Access Management</i>.</p>\n\t\t<p>For information about limits on the number of policies you can associate with a user, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?LimitationsOnEntities.html\" target=\"_blank\">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<note>Because policy documents can be large, you should use POST rather than GET when calling\n\t\t\t\t<code>PutUserPolicy</code>. For information about setting up signatures and authorization\n\t\t\tthrough the API, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html\" target=\"_blank\">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information\n\t\t\tabout using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\" target=\"_blank\">Making\n\t\t\t\tQuery Requests</a> in <i>Using IAM</i>.</note>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=PutUserPolicy\n&UserName=Bob\n&PolicyName=AllAccessPolicy\n&PolicyDocument={\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}]}\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<PutUserPolicyResponse>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</PutUserPolicyResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Adds (or updates) a policy document associated with the specified user. For information about\n\t\t\tpolicies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html\">Overview of Policies</a> in the <i>Using IAM</i> guide.</p>\n\t\t<p>For information about limits on the number of policies you can associate with a user, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\n\t\t<note>Because policy documents can be large, you should use POST rather than GET when calling\n\t\t\t\t<code>PutUserPolicy</code>. For information about setting up signatures and authorization\n\t\t\tthrough the API, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html\">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information\n\t\t\tabout using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\">Making\n\t\t\t\tQuery Requests</a> in the <i>Using IAM</i> guide.</note>\n\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=PutUserPolicy\n&UserName=Bob\n&PolicyName=AllAccessPolicy\n&PolicyDocument={\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}]}\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<PutUserPolicyResponse>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</PutUserPolicyResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"RemoveRoleFromInstanceProfile": {
|
||||
"name": "RemoveRoleFromInstanceProfile",
|
||||
|
|
@ -5485,7 +5687,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -5497,7 +5699,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -5541,7 +5743,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -5553,7 +5755,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -5615,7 +5817,7 @@
|
|||
"message": {
|
||||
"shape_name": "invalidAuthenticationCodeMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because the authentication code was not recognized. The error\n\t\t\tmessage describes the specific error.</p>\n\t"
|
||||
|
|
@ -5627,7 +5829,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -5639,7 +5841,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -5692,7 +5894,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -5704,13 +5906,13 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Changes the status of the specified access key from Active to Inactive, or vice versa. This\n\t\t\taction can be used to disable a user's key as part of a key rotation work flow.</p>\n\t\t<p>If the <code>UserName</code> field is not specified, the UserName is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.</p>\n\t\t<p>For information about rotating keys, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?ManagingCredentials.html\" target=\"_blank\">Managing Keys and Certificates</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=UpdateAccessKey\n&UserName=Bob\n&AccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Status=Inactive\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UpdateAccessKeyResponse>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</UpdateAccessKeyResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Changes the status of the specified access key from Active to Inactive, or vice versa. This\n\t\t\taction can be used to disable a user's key as part of a key rotation work flow.</p>\n\t\t<p>If the <code>UserName</code> field is not specified, the UserName is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.</p>\n\t\t<p>For information about rotating keys, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html\">Managing Keys and Certificates</a> in the <i>Using IAM\n\t\t\t\t</i> guide.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=UpdateAccessKey\n&UserName=Bob\n&AccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Status=Inactive\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UpdateAccessKeyResponse>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</UpdateAccessKeyResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"UpdateAccountPasswordPolicy": {
|
||||
"name": "UpdateAccountPasswordPolicy",
|
||||
|
|
@ -5723,35 +5925,57 @@
|
|||
"type": "integer",
|
||||
"min_length": 6,
|
||||
"max_length": 128,
|
||||
"documentation": null
|
||||
"documentation": "\n <p>The minimum number of characters allowed in an IAM user password.</p>\n "
|
||||
},
|
||||
"RequireSymbols": {
|
||||
"shape_name": "booleanType",
|
||||
"type": "boolean",
|
||||
"documentation": null
|
||||
"documentation": "\n Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters: ! @ # $ % ^ & * ( ) _ + - = [ ] { } | '\n "
|
||||
},
|
||||
"RequireNumbers": {
|
||||
"shape_name": "booleanType",
|
||||
"type": "boolean",
|
||||
"documentation": null
|
||||
"documentation": "\n <p>Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).</p>\n "
|
||||
},
|
||||
"RequireUppercaseCharacters": {
|
||||
"shape_name": "booleanType",
|
||||
"type": "boolean",
|
||||
"documentation": null
|
||||
"documentation": "\n <p>Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).</p>\n "
|
||||
},
|
||||
"RequireLowercaseCharacters": {
|
||||
"shape_name": "booleanType",
|
||||
"type": "boolean",
|
||||
"documentation": null
|
||||
"documentation": "\n <p>Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).</p>\n "
|
||||
},
|
||||
"AllowUsersToChangePassword": {
|
||||
"shape_name": "booleanType",
|
||||
"type": "boolean",
|
||||
"documentation": null
|
||||
"documentation": "\n <p>Allows all IAM users in your account to use the AWS Management Console to change their own passwords. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/HowToPwdIAMUser.html\">Letting IAM Users Change Their Own Passwords</a> in the <i>Using IAM</i> guide.</p>\n "
|
||||
},
|
||||
"MaxPasswordAge": {
|
||||
"shape_name": "maxPasswordAgeType",
|
||||
"type": "integer",
|
||||
"min_length": 1,
|
||||
"max_length": 1095,
|
||||
"box": true,
|
||||
"documentation": "\n <p>The number of days that an IAM user password is valid.</p>\n "
|
||||
},
|
||||
"PasswordReusePrevention": {
|
||||
"shape_name": "passwordReusePreventionType",
|
||||
"type": "integer",
|
||||
"min_length": 1,
|
||||
"max_length": 24,
|
||||
"box": true,
|
||||
"documentation": "\n <p>Specifies the number of previous passwords that IAM users are prevented from reusing.</p>\n "
|
||||
},
|
||||
"HardExpiry": {
|
||||
"shape_name": "booleanObjectType",
|
||||
"type": "boolean",
|
||||
"box": true,
|
||||
"documentation": "\n <p>Prevents IAM users from setting a new password after their password has expired.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": null
|
||||
"documentation": " "
|
||||
},
|
||||
"output": null,
|
||||
"errors": [
|
||||
|
|
@ -5762,7 +5986,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -5774,7 +5998,7 @@
|
|||
"message": {
|
||||
"shape_name": "malformedPolicyDocumentMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.</p>\n\t"
|
||||
|
|
@ -5786,13 +6010,13 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Updates the password policy settings for the account. For more information about using a\n\t\t\tpassword policy, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html\">Managing an\n\t\t\t\tIAM Password Policy</a>.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=UpdateAccountPasswordPolicy\n&MinimumPasswordLength=9\n&RequireSymbols=true\n&RequireNumbers=false\n&RequireUppercaseCharacters=true\n&RequireLowercaseCharacters=true\n&AllowUsersToChangePassword=true\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UpdateAccountPasswordPolicyResponse>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</UpdateAccountPasswordPolicyResponse>\n</queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Updates the password policy settings for the account. For more information about using a\n\t\t\tpassword policy, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html\">Managing an\n\t\t\t\tIAM Password Policy</a> in the <i>Using IAM</i> guide.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=UpdateAccountPasswordPolicy\n&MinimumPasswordLength=12\n&RequireSymbols=false\n&RequireNumbers=true\n&RequireUppercaseCharacters=true\n&RequireLowercaseCharacters=true\n&AllowUsersToChangePassword=true\n&MaxPasswordAge=90\n&PasswordReusePrevention=6\n&HardExpiry=false\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UpdateAccountPasswordPolicyResponse>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</UpdateAccountPasswordPolicyResponse>\n</queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"UpdateAssumeRolePolicy": {
|
||||
"name": "UpdateAssumeRolePolicy",
|
||||
|
|
@ -5830,7 +6054,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -5842,7 +6066,7 @@
|
|||
"message": {
|
||||
"shape_name": "malformedPolicyDocumentMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.</p>\n\t"
|
||||
|
|
@ -5854,13 +6078,13 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Updates the policy that grants an entity permission to assume a role. Currently, only an\n\t\t\tAmazon EC2 instance can assume a role. For more information about roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html\">Working with\n\t\t\tRoles</a>.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=UpdateAssumeRolePolicy\n&PolicyDocument={\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}\n&RoleName=S3Access\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UpdateAssumeRolePolicyResponse xmlns=\"https://iam.amazonaws.com/doc/2010-05-08/\">\n <ResponseMetadata>\n <RequestId>309c1671-99ed-11e1-a4c3-270EXAMPLE04</RequestId>\n </ResponseMetadata>\n</UpdateAssumeRolePolicyResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Updates the policy that grants an entity permission to assume a role. For more information about roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html\">Working with\n\t\t\tRoles</a>.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=UpdateAssumeRolePolicy\n&PolicyDocument={\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}\n&RoleName=S3Access\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UpdateAssumeRolePolicyResponse xmlns=\"https://iam.amazonaws.com/doc/2010-05-08/\">\n <ResponseMetadata>\n <RequestId>309c1671-99ed-11e1-a4c3-270EXAMPLE04</RequestId>\n </ResponseMetadata>\n</UpdateAssumeRolePolicyResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"UpdateGroup": {
|
||||
"name": "UpdateGroup",
|
||||
|
|
@ -5905,7 +6129,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -5917,7 +6141,7 @@
|
|||
"message": {
|
||||
"shape_name": "entityAlreadyExistsMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create a resource that already exists.</p>\n\t"
|
||||
|
|
@ -5929,13 +6153,13 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Updates the name and/or the path of the specified group.</p>\n\t\t<important> You should understand the implications of changing a group's path or name. For more\n\t\t\tinformation, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Renaming.html\" target=\"_blank\">Renaming Users and Groups</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>. </important>\n\t\t<note>To change a group name the requester must have appropriate permissions on both the source\n\t\t\tobject and the target object. For example, to change Managers to MGRs, the entity making the\n\t\t\trequest must have permission on Managers and MGRs, or must have permission on all (*). For\n\t\t\tmore information about permissions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html\" target=\"blank\">Permissions and Policies</a>. </note>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=UpdateGroup\n&GroupName=Test\n&NewGroupName=Test_1\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UpdateGroupResponse>\n <UpdateGroupResult>\n <Group xmlns=\"http://iam.amazonaws.com/doc/2010-05-08/\">\n <Path>/division_abc/subdivision_xyz/product_1234/engineering/</Path>\n <GroupName>Test_1</GroupName>\n <GroupId>AGP2MAB8DPLSRHEXAMPLE</GroupId>\n <Arn>arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/\n product_1234/engineering/Test_1</Arn>\n </Group>\n </UpdateGroupResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</UpdateGroupResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Updates the name and/or the path of the specified group.</p>\n\t\t<important> You should understand the implications of changing a group's path or name. For more\n\t\t information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html\">Renaming Users and Groups</a> in the <i>Using IAM</i> guide. </important>\n\n\t\t<note>To change a group name the requester must have appropriate permissions on both the source\n\t\t\tobject and the target object. For example, to change Managers to MGRs, the entity making the\n\t\t\trequest must have permission on Managers and MGRs, or must have permission on all (*). For\n\t\t\tmore information about permissions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html\" target=\"blank\">Permissions and Policies</a>. </note>\n\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=UpdateGroup\n&GroupName=Test\n&NewGroupName=Test_1\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UpdateGroupResponse>\n <UpdateGroupResult>\n <Group xmlns=\"http://iam.amazonaws.com/doc/2010-05-08/\">\n <Path>/division_abc/subdivision_xyz/product_1234/engineering/</Path>\n <GroupName>Test_1</GroupName>\n <GroupId>AGP2MAB8DPLSRHEXAMPLE</GroupId>\n <Arn>arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/\n product_1234/engineering/Test_1</Arn>\n </Group>\n </UpdateGroupResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</UpdateGroupResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"UpdateLoginProfile": {
|
||||
"name": "UpdateLoginProfile",
|
||||
|
|
@ -5959,11 +6183,16 @@
|
|||
"max_length": 128,
|
||||
"pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+",
|
||||
"sensitive": true,
|
||||
"documentation": "\n\t\t<p>The new password for the user name.</p>\n\t",
|
||||
"required": true
|
||||
"documentation": "\n\t\t<p>The new password for the specified user.</p>\n\t"
|
||||
},
|
||||
"PasswordResetRequired": {
|
||||
"shape_name": "booleanObjectType",
|
||||
"type": "boolean",
|
||||
"box": true,
|
||||
"documentation": "\n <p>Require the specified user to set a new password on next sign-in.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": null
|
||||
"documentation": " "
|
||||
},
|
||||
"output": null,
|
||||
"errors": [
|
||||
|
|
@ -5974,7 +6203,7 @@
|
|||
"message": {
|
||||
"shape_name": "entityTemporarilyUnmodifiableMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that is temporarily unmodifiable,\n\t\t\tsuch as a user name that was deleted and then recreated. The error indicates that the request\n\t\t\tis likely to succeed if you try again after waiting several minutes. The error message\n\t\t\tdescribes the entity.</p>\n\t"
|
||||
|
|
@ -5986,7 +6215,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -6010,7 +6239,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -6065,7 +6294,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -6089,13 +6318,13 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Updates the metadata document for an existing SAML provider.</p>\n\t\t<note>This operation requires <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version\n\t\t\t4</a>.</note>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=UpdateSAMLProvider\n&Name=arn:aws:iam::123456789012:saml-metadata/MyUniversity\n&SAMLProviderDocument=VGhpcyBpcyB3aGVyZSB5b3UgcHV0IHRoZSBTQU1MIHByb3ZpZGVyIG1ldGFkYXRhIGRvY3VtZW50\nLCBCYXNlNjQtZW5jb2RlZCBpbnRvIGEgYmlnIHN0cmluZy4=\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UpdateSAMLProviderResponse xmlns=\"https://iam.amazonaws.com/doc/2010-05-08/\">\n <UpdateSAMLProviderResult>\n <SAMLProviderArn>arn:aws:iam::123456789012:saml-metadata/MyUniversity</SAMLProviderArn>\n </UpdateSAMLProviderResult>\n <ResponseMetadata>\n <RequestId>29f47818-99f5-11e1-a4c3-27EXAMPLE804</RequestId>\n </ResponseMetadata>\n</UpdateSAMLProviderResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Updates the metadata document for an existing SAML provider.</p>\n\n\t\t<note>This operation requires <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version\n\t\t\t4</a>.</note>\n\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=UpdateSAMLProvider\n&Name=arn:aws:iam::123456789012:saml-metadata/MyUniversity\n&SAMLProviderDocument=VGhpcyBpcyB3aGVyZSB5b3UgcHV0IHRoZSBTQU1MIHByb3ZpZGVyIG1ldGFkYXRhIGRvY3VtZW50\nLCBCYXNlNjQtZW5jb2RlZCBpbnRvIGEgYmlnIHN0cmluZy4=\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UpdateSAMLProviderResponse xmlns=\"https://iam.amazonaws.com/doc/2010-05-08/\">\n <UpdateSAMLProviderResult>\n <SAMLProviderArn>arn:aws:iam::123456789012:saml-metadata/MyUniversity</SAMLProviderArn>\n </UpdateSAMLProviderResult>\n <ResponseMetadata>\n <RequestId>29f47818-99f5-11e1-a4c3-27EXAMPLE804</RequestId>\n </ResponseMetadata>\n</UpdateSAMLProviderResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"UpdateServerCertificate": {
|
||||
"name": "UpdateServerCertificate",
|
||||
|
|
@ -6140,7 +6369,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -6152,7 +6381,7 @@
|
|||
"message": {
|
||||
"shape_name": "entityAlreadyExistsMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create a resource that already exists.</p>\n\t"
|
||||
|
|
@ -6164,13 +6393,13 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Updates the name and/or the path of the specified server certificate.</p>\n\t\t<important> You should understand the implications of changing a server certificate's path or\n\t\t\tname. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingServerCerts.html\" target=\"_blank\">Managing Server Certificates</a> in <i>Using AWS Identity and Access Management</i>. </important>\n\t\t<note>To change a server certificate name the requester must have appropriate permissions on\n\t\t\tboth the source object and the target object. For example, to change the name from\n\t\t\tProductionCert to ProdCert, the entity making the request must have permission on\n\t\t\tProductionCert and ProdCert, or must have permission on all (*). For more information about\n\t\t\tpermissions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html\" target=\"blank\">Permissions and Policies</a>. </note>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=UpdateServerCertificate\n&ServerCertificateName=ProdServerCert\n&NewServerCertificateName=ProdServerCertName\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UpdateServerCertificateResponse>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</UpdateServerCertificateResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Updates the name and/or the path of the specified server certificate.</p>\n\t\t<important> You should understand the implications of changing a server certificate's path or\n\t\t\tname. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingServerCerts.html\">Managing Server Certificates</a> in the <i>Using IAM</i> guide. </important>\n\n\t\t<note>To change a server certificate name the requester must have appropriate permissions on\n\t\t\tboth the source object and the target object. For example, to change the name from\n\t\t\tProductionCert to ProdCert, the entity making the request must have permission on\n\t\t\tProductionCert and ProdCert, or must have permission on all (*). For more information about\n\t\t\tpermissions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html\" target=\"blank\">Permissions and Policies</a>. </note>\n\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=UpdateServerCertificate\n&ServerCertificateName=ProdServerCert\n&NewServerCertificateName=ProdServerCertName\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UpdateServerCertificateResponse>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</UpdateServerCertificateResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"UpdateSigningCertificate": {
|
||||
"name": "UpdateSigningCertificate",
|
||||
|
|
@ -6217,7 +6446,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -6229,13 +6458,13 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Changes the status of the specified signing certificate from active to disabled, or vice\n\t\t\tversa. This action can be used to disable a user's signing certificate as part of a\n\t\t\tcertificate rotation work flow.</p>\n\t\t<p>If the <code>UserName</code> field is not specified, the UserName is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.</p>\n\t\t<p>For information about rotating certificates, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?ManagingCredentials.html\" target=\"_blank\">Managing Keys and Certificates</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=UpdateSigningCertificate\n&UserName=Bob\n&CertificateId=TA7SMP42TDN5Z26OBPJE7EXAMPLE\n&Status=Inactive\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UpdateSigningCertificateResponse>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</UpdateSigningCertificateResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Changes the status of the specified signing certificate from active to disabled, or vice\n\t\t\tversa. This action can be used to disable a user's signing certificate as part of a\n\t\t\tcertificate rotation work flow.</p>\n\t\t<p>If the <code>UserName</code> field is not specified, the UserName is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.</p>\n\t\t<p>For information about rotating certificates, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html\">Managing Keys and Certificates</a> in the <i>Using IAM</i> guide.</p>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=UpdateSigningCertificate\n&UserName=Bob\n&CertificateId=TA7SMP42TDN5Z26OBPJE7EXAMPLE\n&Status=Inactive\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UpdateSigningCertificateResponse>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</UpdateSigningCertificateResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"UpdateUser": {
|
||||
"name": "UpdateUser",
|
||||
|
|
@ -6280,7 +6509,7 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
|
|
@ -6292,7 +6521,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -6304,7 +6533,7 @@
|
|||
"message": {
|
||||
"shape_name": "entityAlreadyExistsMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create a resource that already exists.</p>\n\t"
|
||||
|
|
@ -6316,13 +6545,13 @@
|
|||
"message": {
|
||||
"shape_name": "entityTemporarilyUnmodifiableMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that is temporarily unmodifiable,\n\t\t\tsuch as a user name that was deleted and then recreated. The error indicates that the request\n\t\t\tis likely to succeed if you try again after waiting several minutes. The error message\n\t\t\tdescribes the entity.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Updates the name and/or the path of the specified user.</p>\n\t\t<important> You should understand the implications of changing a user's path or name. For more\n\t\t\tinformation, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Renaming.html\" target=\"_blank\">Renaming Users and Groups</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>. </important>\n\t\t<note>To change a user name the requester must have appropriate permissions on both the source\n\t\t\tobject and the target object. For example, to change Bob to Robert, the entity making the\n\t\t\trequest must have permission on Bob and Robert, or must have permission on all (*). For more\n\t\t\tinformation about permissions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html\" target=\"blank\">Permissions and Policies</a>. </note>\n\t\t<examples>\n\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=UpdateUser\n&UserName=Bob\n&NewUserName=Robert\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UpdateUserResponse>\n <UpdateUserResult>\n <User>\n <Path>/division_abc/subdivision_xyz/</Path>\n <UserName>Robert</UserName>\n <UserId>AIDACKCEVSQ6C2EXAMPLE</UserId>\n <Arn>arn:aws::123456789012:user/division_abc/subdivision_xyz/Robert\n </Arn>\n </User>\n </UpdateUserResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</UpdateUserResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Updates the name and/or the path of the specified user.</p>\n\n\t\t<important> You should understand the implications of changing a user's path or name. For more\n\t\t information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html\">Renaming Users and Groups</a> in the <i>Using IAM</i> guide. </important>\n\t\t<note>To change a user name the requester must have appropriate permissions on both the source\n\t\t\tobject and the target object. For example, to change Bob to Robert, the entity making the\n\t\t\trequest must have permission on Bob and Robert, or must have permission on all (*). For more\n\t\t\tinformation about permissions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html\" target=\"blank\">Permissions and Policies</a>. </note>\n\t\t<examples>\n\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=UpdateUser\n&UserName=Bob\n&NewUserName=Robert\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UpdateUserResponse>\n <UpdateUserResult>\n <User>\n <Path>/division_abc/subdivision_xyz/</Path>\n <UserName>Robert</UserName>\n <UserId>AIDACKCEVSQ6C2EXAMPLE</UserId>\n <Arn>arn:aws::123456789012:user/division_abc/subdivision_xyz/Robert\n </Arn>\n </User>\n </UpdateUserResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</UpdateUserResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"UploadServerCertificate": {
|
||||
"name": "UploadServerCertificate",
|
||||
|
|
@ -6336,7 +6565,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>The path for the server certificate. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<p>This parameter is optional. If it is not included, it defaults to a slash (/).</p>\n\t"
|
||||
"documentation": "\n\n\t\t<p>The path for the server certificate. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\n\t\t<p>This parameter is optional. If it is not included, it defaults to a slash (/).</p>\n\n\t\t<note>If you are uploading a server certificate specifically for use with Amazon CloudFront\n\t\t\tdistributions, you must specify a path using the <code>--path</code> option. The path must begin\n\t\t\twith <code>/cloudfront</code> and must include a trailing slash (for example, <code>/cloudfront/test/</code>).\n\t\t</note>\n\n\t"
|
||||
},
|
||||
"ServerCertificateName": {
|
||||
"shape_name": "serverCertificateNameType",
|
||||
|
|
@ -6391,7 +6620,7 @@
|
|||
"min_length": 1,
|
||||
"max_length": 512,
|
||||
"pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
|
||||
"documentation": "\n\t\t<p>Path to the server certificate. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>Path to the server certificate. For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"ServerCertificateName": {
|
||||
|
|
@ -6409,7 +6638,7 @@
|
|||
"min_length": 16,
|
||||
"max_length": 32,
|
||||
"pattern": "[\\w]*",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the server certificate. For more information about\n\t\t\tIDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The stable and unique string identifying the server certificate. For more information about\n\t\t\tIDs, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"Arn": {
|
||||
|
|
@ -6417,13 +6646,18 @@
|
|||
"type": "string",
|
||||
"min_length": 20,
|
||||
"max_length": 2048,
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the server certificate. For more information about\n\t\t\tARNs and how to use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t",
|
||||
"documentation": "\n\t\t<p>The Amazon Resource Name (ARN) specifying the server certificate. For more information about\n\t\t\tARNs and how to use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">Identifiers for IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\t",
|
||||
"required": true
|
||||
},
|
||||
"UploadDate": {
|
||||
"shape_name": "dateType",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n\t\t<p>The date when the server certificate was uploaded.</p>\n\t"
|
||||
"documentation": "\n\t\t<p>The date when the server certificate was uploaded.</p>\n "
|
||||
},
|
||||
"Expiration": {
|
||||
"shape_name": "dateType",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n <p>The date on which the certificate is set to expire.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The meta information of the uploaded server certificate without its certificate body,\n\t\t\tcertificate chain, and private key.</p>\n\t"
|
||||
|
|
@ -6439,7 +6673,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -6451,7 +6685,7 @@
|
|||
"message": {
|
||||
"shape_name": "entityAlreadyExistsMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create a resource that already exists.</p>\n\t"
|
||||
|
|
@ -6463,7 +6697,7 @@
|
|||
"message": {
|
||||
"shape_name": "malformedCertificateMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because the certificate was malformed or expired. The error message\n\t\t\tdescribes the specific error.</p>\n\t"
|
||||
|
|
@ -6475,13 +6709,13 @@
|
|||
"message": {
|
||||
"shape_name": "keyPairMismatchMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because the public key certificate and the private key do not\n\t\t\tmatch.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Uploads a server certificate entity for the AWS account. The server certificate entity\n\t\t\tincludes a public key certificate, a private key, and an optional certificate chain, which\n\t\t\tshould all be PEM-encoded.</p>\n\t\t<p>For information about the number of server certificates you can upload, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?LimitationsOnEntities.html\" target=\"_blank\">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access\n\t\t\t\tManagement</i>.</p>\n\t\t<note>Because the body of the public key certificate, private key, and the certificate chain can\n\t\t\tbe large, you should use POST rather than GET when calling\n\t\t\t\t<code>UploadServerCertificate</code>. For information about setting up signatures and\n\t\t\tauthorization through the API, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html\" target=\"_blank\">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information\n\t\t\tabout using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\" target=\"_blank\">Making\n\t\t\t\tQuery Requests</a> in <i>Using IAM</i>.</note>\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=UploadServerCertificate\n&ServerCertificateName=ProdServerCert\n&Path=/company/servercerts/\n&CertificateBody=-----BEGIN CERTIFICATE-----\nMIICdzCCAeCgAwIBAgIGANc+Ha2wMA0GCSqGSIb3DQEBBQUAMFMxCzAJBgNVBAYT\nAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMQwwCgYDVQQLEwNBV1MxITAfBgNVBAMT\nGEFXUyBMaW1pdGVkLUFzc3VyYW5jZSBDQTAeFw0wOTAyMDQxNzE5MjdaFw0xMDAy\nMDQxNzE5MjdaMFIxCzAJBgNVBAYTAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMRcw\nFQYDVQQLEw5BV1MtRGV2ZWxvcGVyczEVMBMGA1UEAxMMNTdxNDl0c3ZwYjRtMIGf\nMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCpB/vsOwmT/O0td1RqzKjttSBaPjbr\ndqwNe9BrOyB08fw2+Ch5oonZYXfGUrT6mkYXH5fQot9HvASrzAKHO596FdJA6DmL\nywdWe1Oggk7zFSXO1Xv+3vPrJtaYxYo3eRIp7w80PMkiOv6M0XK8ubcTouODeJbf\nsuDqcLnLDxwsvwIDAQABo1cwVTAOBgNVHQ8BAf8EBAMCBaAwFgYDVR0lAQH/BAww\nCgYIKwYBBQUHAwIwDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQULGNaBphBumaKbDRK\nCAi0mH8B3mowDQYJKoZIhvcNAQEFBQADgYEAuKxhkXaCLGcqDuweKtO/AEw9ZePH\nwr0XqsaIK2HZboqruebXEGsojK4Ks0WzwgrEynuHJwTn760xe39rSqXWIOGrOBaX\nwFpWHVjTFMKk+tSDG1lssLHyYWWdFFU4AnejRGORJYNaRHgVTKjHphc5jEhHm0BX\nAEaHzTpmEXAMPLE=\n-----END CERTIFICATE-----\n&PrivateKey=-----BEGIN DSA PRIVATE KEY-----\nMIIBugIBTTKBgQD33xToSXPJ6hr37L3+KNi3/7DgywlBcvlFPPSHIw3ORuO/22mT\n8Cy5fT89WwNvZ3BPKWU6OZ38TQv3eWjNc/3U3+oqVNG2poX5nCPOtO1b96HYX2mR\n3FTdH6FRKbQEhpDzZ6tRrjTHjMX6sT3JRWkBd2c4bGu+HUHO1H7QvrCTeQIVTKMs\nTCKCyrLiGhUWuUGNJUMU6y6zToGTHl84Tz7TPwDGDXuy/Dk5s4jTVr+xibROC/gS\nQrs4Dzz3T1ze6lvU8S1KT9UsOB5FUJNTTPCPey+Lo4mmK6b23XdTyCIT8e2fsm2j\njHHC1pIPiTkdLS3j6ZYjF8LY6TENFng+LDY/xwPOl7TJVoD3J/WXC2J9CEYq9o34\nkq6WWn3CgYTuo54nXUgnoCb3xdG8COFrg+oTbIkHTSzs3w5o/GGgKK7TDF3UlJjq\nvHNyJQ6kWBrQRR1Xp5KYQ4c/Dm5kef+62mH53HpcCELguWVcffuVQpmq3EWL9Zp9\njobTJQ2VHjb5IVxiO6HRSd27di3njyrzUuJCyHSDTqwLJmTThpd6OTIUTL3Tc4m2\n62TITdw53KWJEXAMPLE=\n-----END DSA PRIVATE KEY-----\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UploadServerCertificateResponse>\n <UploadServerCertificateResult>\n <ServerCertificateMetadata>\n <ServerCertificateName>ProdServerCert</ServerCertificateName>\n <Path>/company/servercerts/</Path>\n <Arn>arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert</Arn>\n <UploadDate>2010-05-08T01:02:03.004Z</UploadDate>\n <ServerCertificateId>ASCACKCEVSQ6C2EXAMPLE</ServerCertificateId>\n </ServerCertificateMetadata>\n </UploadServerCertificateResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</UploadServerCertificateResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Uploads a server certificate entity for the AWS account. The server certificate entity\n\t\t\tincludes a public key certificate, a private key, and an optional certificate chain, which\n\t\t\tshould all be PEM-encoded.</p>\n\t\t<p>For information about the number of server certificates you can upload, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide.</p>\n\n\n\t\t<note>Because the body of the public key certificate, private key, and the certificate chain can\n\t\t\tbe large, you should use POST rather than GET when calling\n\t\t\t\t<code>UploadServerCertificate</code>. For information about setting up signatures and\n\t\t\tauthorization through the API, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html\">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information\n\t\t\tabout using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\">Making\n\t\t\t\tQuery Requests</a> in the <i>Using IAM</i> guide.</note>\n\n\t\t<examples>\n\t\t\t<queryrequest>\nhttps://iam.amazonaws.com/\n?Action=UploadServerCertificate\n&ServerCertificateName=ProdServerCert\n&Path=/company/servercerts/\n&CertificateBody=-----BEGIN CERTIFICATE-----\nMIICdzCCAeCgAwIBAgIGANc+Ha2wMA0GCSqGSIb3DQEBBQUAMFMxCzAJBgNVBAYT\nAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMQwwCgYDVQQLEwNBV1MxITAfBgNVBAMT\nGEFXUyBMaW1pdGVkLUFzc3VyYW5jZSBDQTAeFw0wOTAyMDQxNzE5MjdaFw0xMDAy\nMDQxNzE5MjdaMFIxCzAJBgNVBAYTAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMRcw\nFQYDVQQLEw5BV1MtRGV2ZWxvcGVyczEVMBMGA1UEAxMMNTdxNDl0c3ZwYjRtMIGf\nMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCpB/vsOwmT/O0td1RqzKjttSBaPjbr\ndqwNe9BrOyB08fw2+Ch5oonZYXfGUrT6mkYXH5fQot9HvASrzAKHO596FdJA6DmL\nywdWe1Oggk7zFSXO1Xv+3vPrJtaYxYo3eRIp7w80PMkiOv6M0XK8ubcTouODeJbf\nsuDqcLnLDxwsvwIDAQABo1cwVTAOBgNVHQ8BAf8EBAMCBaAwFgYDVR0lAQH/BAww\nCgYIKwYBBQUHAwIwDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQULGNaBphBumaKbDRK\nCAi0mH8B3mowDQYJKoZIhvcNAQEFBQADgYEAuKxhkXaCLGcqDuweKtO/AEw9ZePH\nwr0XqsaIK2HZboqruebXEGsojK4Ks0WzwgrEynuHJwTn760xe39rSqXWIOGrOBaX\nwFpWHVjTFMKk+tSDG1lssLHyYWWdFFU4AnejRGORJYNaRHgVTKjHphc5jEhHm0BX\nAEaHzTpmEXAMPLE=\n-----END CERTIFICATE-----\n&PrivateKey=-----BEGIN DSA PRIVATE KEY-----\nMIIBugIBTTKBgQD33xToSXPJ6hr37L3+KNi3/7DgywlBcvlFPPSHIw3ORuO/22mT\n8Cy5fT89WwNvZ3BPKWU6OZ38TQv3eWjNc/3U3+oqVNG2poX5nCPOtO1b96HYX2mR\n3FTdH6FRKbQEhpDzZ6tRrjTHjMX6sT3JRWkBd2c4bGu+HUHO1H7QvrCTeQIVTKMs\nTCKCyrLiGhUWuUGNJUMU6y6zToGTHl84Tz7TPwDGDXuy/Dk5s4jTVr+xibROC/gS\nQrs4Dzz3T1ze6lvU8S1KT9UsOB5FUJNTTPCPey+Lo4mmK6b23XdTyCIT8e2fsm2j\njHHC1pIPiTkdLS3j6ZYjF8LY6TENFng+LDY/xwPOl7TJVoD3J/WXC2J9CEYq9o34\nkq6WWn3CgYTuo54nXUgnoCb3xdG8COFrg+oTbIkHTSzs3w5o/GGgKK7TDF3UlJjq\nvHNyJQ6kWBrQRR1Xp5KYQ4c/Dm5kef+62mH53HpcCELguWVcffuVQpmq3EWL9Zp9\njobTJQ2VHjb5IVxiO6HRSd27di3njyrzUuJCyHSDTqwLJmTThpd6OTIUTL3Tc4m2\n62TITdw53KWJEXAMPLE=\n-----END DSA PRIVATE KEY-----\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UploadServerCertificateResponse>\n <UploadServerCertificateResult>\n <ServerCertificateMetadata>\n <ServerCertificateName>ProdServerCert</ServerCertificateName>\n <Path>/company/servercerts/</Path>\n <Arn>arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert</Arn>\n <UploadDate>2010-05-08T01:02:03.004Z</UploadDate>\n <ServerCertificateId>ASCACKCEVSQ6C2EXAMPLE</ServerCertificateId>\n <Expiration>2012-05-08T01:02:03.004Z</Expiration>\n </ServerCertificateMetadata>\n </UploadServerCertificateResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</UploadServerCertificateResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
},
|
||||
"UploadSigningCertificate": {
|
||||
"name": "UploadSigningCertificate",
|
||||
|
|
@ -6574,7 +6808,7 @@
|
|||
"message": {
|
||||
"shape_name": "limitExceededMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.</p>\n\t"
|
||||
|
|
@ -6586,7 +6820,7 @@
|
|||
"message": {
|
||||
"shape_name": "entityAlreadyExistsMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it attempted to create a resource that already exists.</p>\n\t"
|
||||
|
|
@ -6598,7 +6832,7 @@
|
|||
"message": {
|
||||
"shape_name": "malformedCertificateMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because the certificate was malformed or expired. The error message\n\t\t\tdescribes the specific error.</p>\n\t"
|
||||
|
|
@ -6610,7 +6844,7 @@
|
|||
"message": {
|
||||
"shape_name": "invalidCertificateMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because the certificate is invalid.</p>\n\t"
|
||||
|
|
@ -6622,7 +6856,7 @@
|
|||
"message": {
|
||||
"shape_name": "duplicateCertificateMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because the same certificate is associated to another user under the\n\t\t\taccount.</p>\n\t"
|
||||
|
|
@ -6634,13 +6868,13 @@
|
|||
"message": {
|
||||
"shape_name": "noSuchEntityMessage",
|
||||
"type": "string",
|
||||
"documentation": " "
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n\t\t<p>The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.</p>\n\t"
|
||||
}
|
||||
],
|
||||
"documentation": "\n\t\t<p>Uploads an X.509 signing certificate and associates it with the specified user. Some AWS\n\t\t\tservices use X.509 signing certificates to validate requests that are signed with a\n\t\t\tcorresponding private key. When you upload the certificate, its default status is\n\t\t\t\t<code>Active</code>.</p>\n\t\t<p>If the <code>UserName</code> field is not specified, the user name is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.</p>\n\t\t<note>Because the body of a X.509 certificate can be large, you should use POST rather than GET\n\t\t\twhen calling <code>UploadSigningCertificate</code>. For information about setting up\n\t\t\tsignatures and authorization through the API, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html\" target=\"_blank\">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information\n\t\t\tabout using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\" target=\"_blank\">Making\n\t\t\t\tQuery Requests</a> in <i>Using IAM</i>.</note>\n\t\t<examples>\n\t\t\t<queryrequest>\nPOST / HTTP/1.1\nHost: iam.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\n\nAction=UploadSigningCertificate\n&UserName=Bob\n&CertificateBody=-----BEGIN CERTIFICATE-----\n MIICdzCCAeCgAwIBAgIGANc+Ha2wMA0GCSqGSIb3DQEBBQUAMFMxCzAJBgNVBAYT\n AlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMQwwCgYDVQQLEwNBV1MxITAfBgNVBAMT\n GEFXUyBMaW1pdGVkLUFzc3VyYW5jZSBDQTAeFw0wOTAyMDQxNzE5MjdaFw0xMDAy\n MDQxNzE5MjdaMFIxCzAJBgNVBAYTAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMRcw\n FQYDVQQLEw5BV1MtRGV2ZWxvcGVyczEVMBMGA1UEAxMMNTdxNDl0c3ZwYjRtMIGf\n MA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCpB/vsOwmT/O0td1RqzKjttSBaPjbr\n dqwNe9BrOyB08fw2+Ch5oonZYXfGUrT6mkYXH5fQot9HvASrzAKHO596FdJA6DmL\n ywdWe1Oggk7zFSXO1Xv+3vPrJtaYxYo3eRIp7w80PMkiOv6M0XK8ubcTouODeJbf\n suDqcLnLDxwsvwIDAQABo1cwVTAOBgNVHQ8BAf8EBAMCBaAwFgYDVR0lAQH/BAww\n CgYIKwYBBQUHAwIwDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQULGNaBphBumaKbDRK\n CAi0mH8B3mowDQYJKoZIhvcNAQEFBQADgYEAuKxhkXaCLGcqDuweKtO/AEw9ZePH\n wr0XqsaIK2HZboqruebXEGsojK4Ks0WzwgrEynuHJwTn760xe39rSqXWIOGrOBaX\n wFpWHVjTFMKk+tSDG1lssLHyYWWdFFU4AnejRGORJYNaRHgVTKjHphc5jEhHm0BX\n AEaHzTpmEXAMPLE=\n -----END CERTIFICATE-----\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UploadSigningCertificateResponse>\n <UploadSigningCertificateResult>\n <Certificate>\n <UserName>Bob</UserName>\n <CertificateId>TA7SMP42TDN5Z26OBPJE7EXAMPLE</CertificateId>\n <CertificateBody>-----BEGIN CERTIFICATE-----\n MIICdzCCAeCgAwIBAgIGANc+Ha2wMA0GCSqGSIb3DQEBBQUAMFMxCzAJBgNVBAYT\n AlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMQwwCgYDVQQLEwNBV1MxITAfBgNVBAMT\n GEFXUyBMaW1pdGVkLUFzc3VyYW5jZSBDQTAeFw0wOTAyMDQxNzE5MjdaFw0xMDAy\n MDQxNzE5MjdaMFIxCzAJBgNVBAYTAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMRcw\n FQYDVQQLEw5BV1MtRGV2ZWxvcGVyczEVMBMGA1UEAxMMNTdxNDl0c3ZwYjRtMIGf\n MA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCpB/vsOwmT/O0td1RqzKjttSBaPjbr\n dqwNe9BrOyB08fw2+Ch5oonZYXfGUrT6mkYXH5fQot9HvASrzAKHO596FdJA6DmL\n ywdWe1Oggk7zFSXO1Xv+3vPrJtaYxYo3eRIp7w80PMkiOv6M0XK8ubcTouODeJbf\n suDqcLnLDxwsvwIDAQABo1cwVTAOBgNVHQ8BAf8EBAMCBaAwFgYDVR0lAQH/BAww\n CgYIKwYBBQUHAwIwDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQULGNaBphBumaKbDRK\n CAi0mH8B3mowDQYJKoZIhvcNAQEFBQADgYEAuKxhkXaCLGcqDuweKtO/AEw9ZePH\n wr0XqsaIK2HZboqruebXEGsojK4Ks0WzwgrEynuHJwTn760xe39rSqXWIOGrOBaX\n wFpWHVjTFMKk+tSDG1lssLHyYWWdFFU4AnejRGORJYNaRHgVTKjHphc5jEhHm0BX\n AEaHzTpmEXAMPLE=\n -----END CERTIFICATE-----</CertificateBody>\n <Status>Active</Status>\n </Certificate>\n </UploadSigningCertificateResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</UploadSigningCertificateResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
"documentation": "\n\t\t<p>Uploads an X.509 signing certificate and associates it with the specified user. Some AWS\n\t\t\tservices use X.509 signing certificates to validate requests that are signed with a\n\t\t\tcorresponding private key. When you upload the certificate, its default status is\n\t\t\t\t<code>Active</code>.</p>\n\t\t<p>If the <code>UserName</code> field is not specified, the user name is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.</p>\n\n\t\t<note>Because the body of a X.509 certificate can be large, you should use POST rather than GET\n\t\t\twhen calling <code>UploadSigningCertificate</code>. For information about setting up\n\t\t\tsignatures and authorization through the API, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html\">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information\n\t\t\tabout using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\">Making\n\t\t\t\tQuery Requests</a> in the <i>Using IAM</i>guide.</note>\n\t\t<examples>\n\t\t\t<queryrequest>\nPOST / HTTP/1.1\nHost: iam.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\n\nAction=UploadSigningCertificate\n&UserName=Bob\n&CertificateBody=-----BEGIN CERTIFICATE-----\n MIICdzCCAeCgAwIBAgIGANc+Ha2wMA0GCSqGSIb3DQEBBQUAMFMxCzAJBgNVBAYT\n AlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMQwwCgYDVQQLEwNBV1MxITAfBgNVBAMT\n GEFXUyBMaW1pdGVkLUFzc3VyYW5jZSBDQTAeFw0wOTAyMDQxNzE5MjdaFw0xMDAy\n MDQxNzE5MjdaMFIxCzAJBgNVBAYTAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMRcw\n FQYDVQQLEw5BV1MtRGV2ZWxvcGVyczEVMBMGA1UEAxMMNTdxNDl0c3ZwYjRtMIGf\n MA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCpB/vsOwmT/O0td1RqzKjttSBaPjbr\n dqwNe9BrOyB08fw2+Ch5oonZYXfGUrT6mkYXH5fQot9HvASrzAKHO596FdJA6DmL\n ywdWe1Oggk7zFSXO1Xv+3vPrJtaYxYo3eRIp7w80PMkiOv6M0XK8ubcTouODeJbf\n suDqcLnLDxwsvwIDAQABo1cwVTAOBgNVHQ8BAf8EBAMCBaAwFgYDVR0lAQH/BAww\n CgYIKwYBBQUHAwIwDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQULGNaBphBumaKbDRK\n CAi0mH8B3mowDQYJKoZIhvcNAQEFBQADgYEAuKxhkXaCLGcqDuweKtO/AEw9ZePH\n wr0XqsaIK2HZboqruebXEGsojK4Ks0WzwgrEynuHJwTn760xe39rSqXWIOGrOBaX\n wFpWHVjTFMKk+tSDG1lssLHyYWWdFFU4AnejRGORJYNaRHgVTKjHphc5jEhHm0BX\n AEaHzTpmEXAMPLE=\n -----END CERTIFICATE-----\n&Version=2010-05-08\n&AUTHPARAMS\n </queryrequest>\n\t\t\t<queryresponse>\n<UploadSigningCertificateResponse>\n <UploadSigningCertificateResult>\n <Certificate>\n <UserName>Bob</UserName>\n <CertificateId>TA7SMP42TDN5Z26OBPJE7EXAMPLE</CertificateId>\n <CertificateBody>-----BEGIN CERTIFICATE-----\n MIICdzCCAeCgAwIBAgIGANc+Ha2wMA0GCSqGSIb3DQEBBQUAMFMxCzAJBgNVBAYT\n AlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMQwwCgYDVQQLEwNBV1MxITAfBgNVBAMT\n GEFXUyBMaW1pdGVkLUFzc3VyYW5jZSBDQTAeFw0wOTAyMDQxNzE5MjdaFw0xMDAy\n MDQxNzE5MjdaMFIxCzAJBgNVBAYTAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMRcw\n FQYDVQQLEw5BV1MtRGV2ZWxvcGVyczEVMBMGA1UEAxMMNTdxNDl0c3ZwYjRtMIGf\n MA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCpB/vsOwmT/O0td1RqzKjttSBaPjbr\n dqwNe9BrOyB08fw2+Ch5oonZYXfGUrT6mkYXH5fQot9HvASrzAKHO596FdJA6DmL\n ywdWe1Oggk7zFSXO1Xv+3vPrJtaYxYo3eRIp7w80PMkiOv6M0XK8ubcTouODeJbf\n suDqcLnLDxwsvwIDAQABo1cwVTAOBgNVHQ8BAf8EBAMCBaAwFgYDVR0lAQH/BAww\n CgYIKwYBBQUHAwIwDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQULGNaBphBumaKbDRK\n CAi0mH8B3mowDQYJKoZIhvcNAQEFBQADgYEAuKxhkXaCLGcqDuweKtO/AEw9ZePH\n wr0XqsaIK2HZboqruebXEGsojK4Ks0WzwgrEynuHJwTn760xe39rSqXWIOGrOBaX\n wFpWHVjTFMKk+tSDG1lssLHyYWWdFFU4AnejRGORJYNaRHgVTKjHphc5jEhHm0BX\n AEaHzTpmEXAMPLE=\n -----END CERTIFICATE-----</CertificateBody>\n <Status>Active</Status>\n </Certificate>\n </UploadSigningCertificateResult>\n <ResponseMetadata>\n <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>\n </ResponseMetadata>\n</UploadSigningCertificateResponse>\n </queryresponse>\n\t\t</examples>\n\t"
|
||||
}
|
||||
},
|
||||
"pagination": {
|
||||
|
|
@ -6650,6 +6884,9 @@
|
|||
"more_results": "IsTruncated",
|
||||
"limit_key": "MaxItems",
|
||||
"result_key": "Users",
|
||||
"non_aggregate_keys": [
|
||||
"Group"
|
||||
],
|
||||
"py_input_token": "marker"
|
||||
},
|
||||
"ListAccessKeys": {
|
||||
|
|
|
|||
1302
botocore/data/aws/logs/2014-03-28.json
Normal file
1302
botocore/data/aws/logs/2014-03-28.json
Normal file
File diff suppressed because one or more lines are too long
|
|
@ -89,7 +89,7 @@
|
|||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"documentation": "\n <p><i>Weighted, Regional, and Failover resource record sets only:</i> An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type.</p>\n "
|
||||
"documentation": "\n <p><i>Weighted, Latency, Geo, and Failover resource record sets only:</i> An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type.</p>\n "
|
||||
},
|
||||
"Weight": {
|
||||
"shape_name": "ResourceRecordSetWeight",
|
||||
|
|
@ -114,7 +114,40 @@
|
|||
"sa-east-1",
|
||||
"cn-north-1"
|
||||
],
|
||||
"documentation": "\n <p><i>Regional resource record sets only:</i> Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set.</p>\n "
|
||||
"documentation": "\n <p><i>Latency-based resource record sets only:</i> Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set.</p>\n "
|
||||
},
|
||||
"GeoLocation": {
|
||||
"shape_name": "GeoLocation",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ContinentCode": {
|
||||
"shape_name": "GeoLocationContinentCode",
|
||||
"type": "string",
|
||||
"min_length": 2,
|
||||
"max_length": 2,
|
||||
"documentation": "\n <p>The code for a continent geo location. Note: only continent locations have a continent code.</p>\n <p>Valid values: <code>AF</code> | <code>AN</code> | <code>AS</code> | <code>EU</code> | <code>OC</code> | <code>NA</code> | <code>SA</code></p>\n <p>Constraint: Specifying <code>ContinentCode</code> with either <code>CountryCode</code> or <code>SubdivisionCode</code> returns an <a>InvalidInput</a> error.</p>\n "
|
||||
},
|
||||
"CountryCode": {
|
||||
"shape_name": "GeoLocationCountryCode",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 2,
|
||||
"documentation": "\n <p>The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.</p>\n <p>The default geo location uses a <code>*</code> for the country code. All other country codes follow the ISO 3166 two-character code.</p>\n "
|
||||
},
|
||||
"SubdivisionCode": {
|
||||
"shape_name": "GeoLocationSubdivisionCode",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 3,
|
||||
"documentation": "\n <p>The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.</p>\n <p>Constraint: Specifying <code>SubdivisionCode</code> without <code>CountryCode</code> returns an <a>InvalidInput</a> error.</p>\n "
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"ContinentCode",
|
||||
"CountryCode",
|
||||
"SubdivisionCode"
|
||||
],
|
||||
"documentation": "\n <p><i>Geo location resource record sets only:</i> Among resource record sets that have the same combination of DNS name and type, a value that specifies the geo location for the current resource record set.</p>\n "
|
||||
},
|
||||
"Failover": {
|
||||
"shape_name": "ResourceRecordSetFailover",
|
||||
|
|
@ -201,6 +234,7 @@
|
|||
"SetIdentifier",
|
||||
"Weight",
|
||||
"Region",
|
||||
"GeoLocation",
|
||||
"Failover",
|
||||
"TTL",
|
||||
"ResourceRecords",
|
||||
|
|
@ -360,6 +394,142 @@
|
|||
],
|
||||
"documentation": "\n <p>Use this action to create or change your authoritative DNS information. To use this action, send a <code>POST</code> request to the <code>2013-04-01/hostedzone/<i>hosted Zone ID</i>/rrset</code> resource. The request body must include an XML document with a <code>ChangeResourceRecordSetsRequest</code> element.</p>\n <p>Changes are a list of change items and are considered transactional. For more information on transactional changes, also known as change batches, see <a href=\"http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/RRSchanges.html#RRSchanges_API\">Creating, Changing, and Deleting Resource Record Sets Using the Route 53 API</a> in the <i>Amazon Route 53 Developer Guide</i>.</p>\n <important>Due to the nature of transactional changes, you cannot delete the same resource record set more than once in a single change batch. If you attempt to delete the same change batch more than once, Route 53 returns an <code>InvalidChangeBatch</code> error.</important>\n <p>In response to a <code>ChangeResourceRecordSets</code> request, your DNS data is changed on all Route 53 DNS servers. Initially, the status of a change is <code>PENDING</code>. This means the change has not yet propagated to all the authoritative Route 53 DNS servers. When the change is propagated to all hosts, the change returns a status of <code>INSYNC</code>.</p>\n <p>Note the following limitations on a <code>ChangeResourceRecordSets</code> request:</p>\n <p>- A request cannot contain more than 100 Change elements.</p>\n <p>- A request cannot contain more than 1000 ResourceRecord elements.</p>\n <p>The sum of the number of characters (including spaces) in all <code>Value</code> elements in a request cannot exceed 32,000 characters.</p>\n "
|
||||
},
|
||||
"ChangeTagsForResource": {
|
||||
"name": "ChangeTagsForResource",
|
||||
"http": {
|
||||
"method": "POST",
|
||||
"uri": "/2013-04-01/tags/{ResourceType}/{ResourceId}"
|
||||
},
|
||||
"input": {
|
||||
"shape_name": "ChangeTagsForResourceRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ResourceType": {
|
||||
"shape_name": "TagResourceType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"healthcheck"
|
||||
],
|
||||
"documentation": "\n <p>The type of the resource. The resource type for health checks is <code>healthcheck</code>.</p>\n ",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
},
|
||||
"ResourceId": {
|
||||
"shape_name": "TagResourceId",
|
||||
"type": "string",
|
||||
"max_length": 64,
|
||||
"documentation": "\n <p>The ID of the resource for which you want to add, change, or delete tags.</p>\n ",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
},
|
||||
"AddTags": {
|
||||
"shape_name": "TagList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Tag",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Key": {
|
||||
"shape_name": "TagKey",
|
||||
"type": "string",
|
||||
"max_length": 128,
|
||||
"documentation": "\n <p>The key for a <code>Tag</code>.</p>\n "
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "TagValue",
|
||||
"type": "string",
|
||||
"max_length": 256,
|
||||
"documentation": "\n <p>The value for a <code>Tag</code>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A single tag containing a key and value.</p>\n ",
|
||||
"xmlname": "Tag"
|
||||
},
|
||||
"min_length": 1,
|
||||
"max_length": 10,
|
||||
"documentation": "\n <p>A complex type that contains a list of <code>Tag</code> elements. Each <code>Tag</code> element identifies a tag that you want to add or update for the specified resource.</p>\n "
|
||||
},
|
||||
"RemoveTagKeys": {
|
||||
"shape_name": "TagKeyList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "TagKey",
|
||||
"type": "string",
|
||||
"max_length": 128,
|
||||
"documentation": null,
|
||||
"xmlname": "Key"
|
||||
},
|
||||
"min_length": 1,
|
||||
"max_length": 10,
|
||||
"documentation": "\n <p>A list of <code>Tag</code> keys that you want to remove from the specified resource.</p>\n "
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"ResourceType",
|
||||
"ResourceId",
|
||||
"AddTags",
|
||||
"RemoveTagKeys"
|
||||
],
|
||||
"documentation": "\n <p>A complex type containing information about a request to add, change, or delete the tags that are associated with a resource.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ChangeTagsForResourceResponse",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>Empty response for the request.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Descriptive message for the error response.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Some value specified in the request is invalid or the XML document is malformed.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "NoSuchHealthCheck",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Descriptive message for the error response.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The health check you are trying to get or delete does not exist.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "PriorRequestNotComplete",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The request was rejected because Route 53 was still processing a prior request.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "ThrottlingException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": null
|
||||
}
|
||||
],
|
||||
"documentation": null
|
||||
},
|
||||
"CreateHealthCheck": {
|
||||
"name": "CreateHealthCheck",
|
||||
"http": {
|
||||
|
|
@ -562,12 +732,20 @@
|
|||
],
|
||||
"documentation": "\n <p>A complex type that contains the health check configuration.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"HealthCheckVersion": {
|
||||
"shape_name": "HealthCheckVersion",
|
||||
"type": "long",
|
||||
"min_length": 1,
|
||||
"documentation": "\n <p>The version of the health check. You can optionally pass this value in a call to <code>UpdateHealthCheck</code> to\n prevent overwriting another change to the health check.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"Id",
|
||||
"CallerReference",
|
||||
"HealthCheckConfig"
|
||||
"HealthCheckConfig",
|
||||
"HealthCheckVersion"
|
||||
],
|
||||
"documentation": "\n <p>A complex type that contains identifying information about the health check.</p>\n ",
|
||||
"required": true
|
||||
|
|
@ -1194,6 +1372,177 @@
|
|||
],
|
||||
"documentation": "\n <p> This action returns the current status of a change batch request. The status is one of the following values:</p>\n <p>- <code>PENDING</code> indicates that the changes in this request have not replicated to all Route 53 DNS servers. This is the initial status of all change batch requests.</p>\n <p>- <code>INSYNC</code> indicates that the changes have replicated to all Amazon Route 53 DNS servers. </p>\n "
|
||||
},
|
||||
"GetCheckerIpRanges": {
|
||||
"name": "GetCheckerIpRanges",
|
||||
"http": {
|
||||
"method": "GET",
|
||||
"uri": "/2013-04-01/checkeripranges"
|
||||
},
|
||||
"input": {
|
||||
"shape_name": "GetCheckerIpRangesRequest",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p>Empty request.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "GetCheckerIpRangesResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CheckerIpRanges": {
|
||||
"shape_name": "CheckerIpRanges",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "IPAddressCidr",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "\n <p>A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health checkers.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A complex type that contains the <code>CheckerIpRanges</code> element.</p>\n "
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "\n <p> To retrieve a list of the IP ranges used by Amazon Route 53 health checkers to check the health of your resources, send a <code>GET</code> request to the <code>2013-04-01/checkeripranges</code> resource. You can use these IP addresses to configure router and firewall rules to allow health checkers to check the health of your resources.</p>\n "
|
||||
},
|
||||
"GetGeoLocation": {
|
||||
"name": "GetGeoLocation",
|
||||
"http": {
|
||||
"method": "GET",
|
||||
"uri": "/2013-04-01/geolocation?continentcode={ContinentCode}&countrycode={CountryCode}&subdivisioncode={SubdivisionCode}"
|
||||
},
|
||||
"input": {
|
||||
"shape_name": "GetGeoLocationRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ContinentCode": {
|
||||
"shape_name": "GeoLocationContinentCode",
|
||||
"type": "string",
|
||||
"min_length": 2,
|
||||
"max_length": 2,
|
||||
"documentation": "\n <p>The code for a continent geo location. Note: only continent locations have a continent code.</p>\n <p>Valid values: <code>AF</code> | <code>AN</code> | <code>AS</code> | <code>EU</code> | <code>OC</code> | <code>NA</code> | <code>SA</code></p>\n <p>Constraint: Specifying <code>ContinentCode</code> with either <code>CountryCode</code> or <code>SubdivisionCode</code> returns an <a>InvalidInput</a> error.</p>\n ",
|
||||
"location": "uri"
|
||||
},
|
||||
"CountryCode": {
|
||||
"shape_name": "GeoLocationCountryCode",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 2,
|
||||
"documentation": "\n <p>The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.</p>\n <p>The default geo location uses a <code>*</code> for the country code. All other country codes follow the ISO 3166 two-character code.</p>\n ",
|
||||
"location": "uri"
|
||||
},
|
||||
"SubdivisionCode": {
|
||||
"shape_name": "GeoLocationSubdivisionCode",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 3,
|
||||
"documentation": "\n <p>The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.</p>\n <p>Constraint: Specifying <code>SubdivisionCode</code> without <code>CountryCode</code> returns an <a>InvalidInput</a> error.</p>\n ",
|
||||
"location": "uri"
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"ContinentCode",
|
||||
"CountryCode",
|
||||
"SubdivisionCode"
|
||||
],
|
||||
"documentation": "\n <p>A complex type that contains information about the request to get a geo location.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "GetGeoLocationResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"GeoLocationDetails": {
|
||||
"shape_name": "GeoLocationDetails",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ContinentCode": {
|
||||
"shape_name": "GeoLocationContinentCode",
|
||||
"type": "string",
|
||||
"min_length": 2,
|
||||
"max_length": 2,
|
||||
"documentation": "\n <p>The code for a continent geo location. Note: only continent locations have a continent code.</p>\n "
|
||||
},
|
||||
"ContinentName": {
|
||||
"shape_name": "GeoLocationContinentName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 32,
|
||||
"documentation": "\n <p>The name of the continent. This element is only present if <code>ContinentCode</code> is also present.</p> \n "
|
||||
},
|
||||
"CountryCode": {
|
||||
"shape_name": "GeoLocationCountryCode",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 2,
|
||||
"documentation": "\n <p>The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.</p>\n <p>The default geo location uses a <code>*</code> for the country code. All other country codes follow the ISO 3166 two-character code.</p>\n "
|
||||
},
|
||||
"CountryName": {
|
||||
"shape_name": "GeoLocationCountryName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 64,
|
||||
"documentation": "\n <p>The name of the country. This element is only present if <code>CountryCode</code> is also present.</p> \n "
|
||||
},
|
||||
"SubdivisionCode": {
|
||||
"shape_name": "GeoLocationSubdivisionCode",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 3,
|
||||
"documentation": "\n <p>The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.</p>\n "
|
||||
},
|
||||
"SubdivisionName": {
|
||||
"shape_name": "GeoLocationSubdivisionName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 64,
|
||||
"documentation": "\n <p>The name of the subdivision. This element is only present if <code>SubdivisionCode</code> is also present.</p> \n "
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"ContinentCode",
|
||||
"ContinentName",
|
||||
"CountryCode",
|
||||
"CountryName",
|
||||
"SubdivisionCode",
|
||||
"SubdivisionName"
|
||||
],
|
||||
"documentation": "\n <p>A complex type that contains the information about the specified geo location.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"GeoLocationDetails"
|
||||
],
|
||||
"documentation": "\n <p>A complex type containing information about the specified geo location.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "NoSuchGeoLocation",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Descriptive message for the error response.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The geo location you are trying to get does not exist.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Descriptive message for the error response.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Some value specified in the request is invalid or the XML document is malformed.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": null
|
||||
},
|
||||
"GetHealthCheck": {
|
||||
"name": "GetHealthCheck",
|
||||
"http": {
|
||||
|
|
@ -1317,12 +1666,20 @@
|
|||
],
|
||||
"documentation": "\n <p>A complex type that contains the health check configuration.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"HealthCheckVersion": {
|
||||
"shape_name": "HealthCheckVersion",
|
||||
"type": "long",
|
||||
"min_length": 1,
|
||||
"documentation": "\n <p>The version of the health check. You can optionally pass this value in a call to <code>UpdateHealthCheck</code> to\n prevent overwriting another change to the health check.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"Id",
|
||||
"CallerReference",
|
||||
"HealthCheckConfig"
|
||||
"HealthCheckConfig",
|
||||
"HealthCheckVersion"
|
||||
],
|
||||
"documentation": "\n <p>A complex type that contains the information about the specified health check.</p>\n ",
|
||||
"required": true
|
||||
|
|
@ -1373,6 +1730,34 @@
|
|||
],
|
||||
"documentation": "\n <p> To retrieve the health check, send a <code>GET</code> request to the <code>2013-04-01/healthcheck/<i>health check ID</i></code> resource. </p>\n "
|
||||
},
|
||||
"GetHealthCheckCount": {
|
||||
"name": "GetHealthCheckCount",
|
||||
"http": {
|
||||
"method": "GET",
|
||||
"uri": "/2013-04-01/healthcheckcount"
|
||||
},
|
||||
"input": {
|
||||
"shape_name": "GetHealthCheckCountRequest",
|
||||
"type": "structure",
|
||||
"members": {},
|
||||
"documentation": "\n <p> To retrieve a count of all your health checks, send a <code>GET</code> request to the <code>2013-04-01/healthcheckcount</code> resource.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "GetHealthCheckCountResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"HealthCheckCount": {
|
||||
"shape_name": "HealthCheckCount",
|
||||
"type": "long",
|
||||
"documentation": "\n <p> The number of health checks associated with the current AWS account.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p> A complex type that contains the count of health checks associated with the current AWS account.</p>\n "
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "\n <p> To retrieve a count of all your health checks, send a <code>GET</code> request to the <code>2013-04-01/healthcheckcount</code> resource.</p>\n "
|
||||
},
|
||||
"GetHostedZone": {
|
||||
"name": "GetHostedZone",
|
||||
"http": {
|
||||
|
|
@ -1519,6 +1904,183 @@
|
|||
],
|
||||
"documentation": "\n <p> To retrieve the delegation set for a hosted zone, send a <code>GET</code> request to the <code>2013-04-01/hostedzone/<i>hosted zone ID</i></code> resource. The delegation set is the four Route 53 name servers that were assigned to the hosted zone when you created it.</p>\n "
|
||||
},
|
||||
"ListGeoLocations": {
|
||||
"name": "ListGeoLocations",
|
||||
"http": {
|
||||
"method": "GET",
|
||||
"uri": "/2013-04-01/geolocations?startcontinentcode={StartContinentCode}&startcountrycode={StartCountryCode}&startsubdivisioncode={StartSubdivisionCode}&maxitems={MaxItems}"
|
||||
},
|
||||
"input": {
|
||||
"shape_name": "ListGeoLocationsRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"StartContinentCode": {
|
||||
"shape_name": "GeoLocationContinentCode",
|
||||
"type": "string",
|
||||
"min_length": 2,
|
||||
"max_length": 2,
|
||||
"documentation": "\n <p>The first continent code in the lexicographic ordering of geo locations that you want the <code>ListGeoLocations</code> request to list. For non-continent geo locations, this should be null.</p>\n <p>Valid values: <code>AF</code> | <code>AN</code> | <code>AS</code> | <code>EU</code> | <code>OC</code> | <code>NA</code> | <code>SA</code></p>\n <p>Constraint: Specifying <code>ContinentCode</code> with either <code>CountryCode</code> or <code>SubdivisionCode</code> returns an <a>InvalidInput</a> error.</p>\n ",
|
||||
"location": "uri"
|
||||
},
|
||||
"StartCountryCode": {
|
||||
"shape_name": "GeoLocationCountryCode",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 2,
|
||||
"documentation": "\n <p>The first country code in the lexicographic ordering of geo locations that you want the <code>ListGeoLocations</code> request to list.</p>\n <p>The default geo location uses a <code>*</code> for the country code. All other country codes follow the ISO 3166 two-character code.</p>\n ",
|
||||
"location": "uri"
|
||||
},
|
||||
"StartSubdivisionCode": {
|
||||
"shape_name": "GeoLocationSubdivisionCode",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 3,
|
||||
"documentation": "\n <p>The first subdivision code in the lexicographic ordering of geo locations that you want the <code>ListGeoLocations</code> request to list.</p>\n <p>Constraint: Specifying <code>SubdivisionCode</code> without <code>CountryCode</code> returns an <a>InvalidInput</a> error.</p>\n ",
|
||||
"location": "uri"
|
||||
},
|
||||
"MaxItems": {
|
||||
"shape_name": "PageMaxItems",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The maximum number of geo locations you want in the response body.</p>\n ",
|
||||
"location": "uri"
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"StartContinentCode",
|
||||
"StartCountryCode",
|
||||
"StartSubdivisionCode",
|
||||
"MaxItems"
|
||||
],
|
||||
"documentation": "\n <p> The input for a ListGeoLocations request.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ListGeoLocationsResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"GeoLocationDetailsList": {
|
||||
"shape_name": "GeoLocationDetailsList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "GeoLocationDetails",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ContinentCode": {
|
||||
"shape_name": "GeoLocationContinentCode",
|
||||
"type": "string",
|
||||
"min_length": 2,
|
||||
"max_length": 2,
|
||||
"documentation": "\n <p>The code for a continent geo location. Note: only continent locations have a continent code.</p>\n "
|
||||
},
|
||||
"ContinentName": {
|
||||
"shape_name": "GeoLocationContinentName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 32,
|
||||
"documentation": "\n <p>The name of the continent. This element is only present if <code>ContinentCode</code> is also present.</p> \n "
|
||||
},
|
||||
"CountryCode": {
|
||||
"shape_name": "GeoLocationCountryCode",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 2,
|
||||
"documentation": "\n <p>The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.</p>\n <p>The default geo location uses a <code>*</code> for the country code. All other country codes follow the ISO 3166 two-character code.</p>\n "
|
||||
},
|
||||
"CountryName": {
|
||||
"shape_name": "GeoLocationCountryName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 64,
|
||||
"documentation": "\n <p>The name of the country. This element is only present if <code>CountryCode</code> is also present.</p> \n "
|
||||
},
|
||||
"SubdivisionCode": {
|
||||
"shape_name": "GeoLocationSubdivisionCode",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 3,
|
||||
"documentation": "\n <p>The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.</p>\n "
|
||||
},
|
||||
"SubdivisionName": {
|
||||
"shape_name": "GeoLocationSubdivisionName",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 64,
|
||||
"documentation": "\n <p>The name of the subdivision. This element is only present if <code>SubdivisionCode</code> is also present.</p> \n "
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"ContinentCode",
|
||||
"ContinentName",
|
||||
"CountryCode",
|
||||
"CountryName",
|
||||
"SubdivisionCode",
|
||||
"SubdivisionName"
|
||||
],
|
||||
"documentation": "\n <p>A complex type that contains information about a <code>GeoLocation</code>.</p>\n ",
|
||||
"xmlname": "GeoLocationDetails"
|
||||
},
|
||||
"documentation": "\n <p>A complex type that contains information about the geo locations that are returned by the request.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"IsTruncated": {
|
||||
"shape_name": "PageTruncated",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p> A flag that indicates whether there are more geo locations to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the values included in the <a>ListGeoLocationsResponse$NextContinentCode</a>, <a>ListGeoLocationsResponse$NextCountryCode</a> and <a>ListGeoLocationsResponse$NextSubdivisionCode</a> elements.</p>\n <p>Valid Values: <code>true</code> | <code>false</code></p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"NextContinentCode": {
|
||||
"shape_name": "GeoLocationContinentCode",
|
||||
"type": "string",
|
||||
"min_length": 2,
|
||||
"max_length": 2,
|
||||
"documentation": "\n <p>If the results were truncated, the continent code of the next geo location in the list. This element is present only if <a>ListGeoLocationsResponse$IsTruncated</a> is true and the next geo location to list is a continent location. </p>\n "
|
||||
},
|
||||
"NextCountryCode": {
|
||||
"shape_name": "GeoLocationCountryCode",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 2,
|
||||
"documentation": "\n <p>If the results were truncated, the country code of the next geo location in the list. This element is present only if <a>ListGeoLocationsResponse$IsTruncated</a> is true and the next geo location to list is not a continent location. </p>\n "
|
||||
},
|
||||
"NextSubdivisionCode": {
|
||||
"shape_name": "GeoLocationSubdivisionCode",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 3,
|
||||
"documentation": "\n <p>If the results were truncated, the subdivision code of the next geo location in the list. This element is present only if <a>ListGeoLocationsResponse$IsTruncated</a> is true and the next geo location has a subdivision. </p>\n "
|
||||
},
|
||||
"MaxItems": {
|
||||
"shape_name": "PageMaxItems",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The maximum number of records you requested. The maximum value of <code>MaxItems</code> is 100.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"GeoLocationDetailsList",
|
||||
"IsTruncated",
|
||||
"NextContinentCode",
|
||||
"NextCountryCode",
|
||||
"NextSubdivisionCode",
|
||||
"MaxItems"
|
||||
],
|
||||
"documentation": "\n <p>A complex type that contains information about the geo locations that are returned by the request and information about the response.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Descriptive message for the error response.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Some value specified in the request is invalid or the XML document is malformed.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": null
|
||||
},
|
||||
"ListHealthChecks": {
|
||||
"name": "ListHealthChecks",
|
||||
"http": {
|
||||
|
|
@ -1651,12 +2213,20 @@
|
|||
],
|
||||
"documentation": "\n <p>A complex type that contains the health check configuration.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"HealthCheckVersion": {
|
||||
"shape_name": "HealthCheckVersion",
|
||||
"type": "long",
|
||||
"min_length": 1,
|
||||
"documentation": "\n <p>The version of the health check. You can optionally pass this value in a call to <code>UpdateHealthCheck</code> to\n prevent overwriting another change to the health check.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"Id",
|
||||
"CallerReference",
|
||||
"HealthCheckConfig"
|
||||
"HealthCheckConfig",
|
||||
"HealthCheckVersion"
|
||||
],
|
||||
"documentation": "\n <p>A complex type that contains identifying information about the health check.</p>\n ",
|
||||
"xmlname": "HealthCheck"
|
||||
|
|
@ -2000,7 +2570,7 @@
|
|||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 128,
|
||||
"documentation": "\n <p><i>Weighted, Regional, and Failover resource record sets only:</i> An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type.</p>\n "
|
||||
"documentation": "\n <p><i>Weighted, Latency, Geo, and Failover resource record sets only:</i> An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type.</p>\n "
|
||||
},
|
||||
"Weight": {
|
||||
"shape_name": "ResourceRecordSetWeight",
|
||||
|
|
@ -2025,7 +2595,40 @@
|
|||
"sa-east-1",
|
||||
"cn-north-1"
|
||||
],
|
||||
"documentation": "\n <p><i>Regional resource record sets only:</i> Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set.</p>\n "
|
||||
"documentation": "\n <p><i>Latency-based resource record sets only:</i> Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set.</p>\n "
|
||||
},
|
||||
"GeoLocation": {
|
||||
"shape_name": "GeoLocation",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ContinentCode": {
|
||||
"shape_name": "GeoLocationContinentCode",
|
||||
"type": "string",
|
||||
"min_length": 2,
|
||||
"max_length": 2,
|
||||
"documentation": "\n <p>The code for a continent geo location. Note: only continent locations have a continent code.</p>\n <p>Valid values: <code>AF</code> | <code>AN</code> | <code>AS</code> | <code>EU</code> | <code>OC</code> | <code>NA</code> | <code>SA</code></p>\n <p>Constraint: Specifying <code>ContinentCode</code> with either <code>CountryCode</code> or <code>SubdivisionCode</code> returns an <a>InvalidInput</a> error.</p>\n "
|
||||
},
|
||||
"CountryCode": {
|
||||
"shape_name": "GeoLocationCountryCode",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 2,
|
||||
"documentation": "\n <p>The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.</p>\n <p>The default geo location uses a <code>*</code> for the country code. All other country codes follow the ISO 3166 two-character code.</p>\n "
|
||||
},
|
||||
"SubdivisionCode": {
|
||||
"shape_name": "GeoLocationSubdivisionCode",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 3,
|
||||
"documentation": "\n <p>The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.</p>\n <p>Constraint: Specifying <code>SubdivisionCode</code> without <code>CountryCode</code> returns an <a>InvalidInput</a> error.</p>\n "
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"ContinentCode",
|
||||
"CountryCode",
|
||||
"SubdivisionCode"
|
||||
],
|
||||
"documentation": "\n <p><i>Geo location resource record sets only:</i> Among resource record sets that have the same combination of DNS name and type, a value that specifies the geo location for the current resource record set.</p>\n "
|
||||
},
|
||||
"Failover": {
|
||||
"shape_name": "ResourceRecordSetFailover",
|
||||
|
|
@ -2112,6 +2715,7 @@
|
|||
"SetIdentifier",
|
||||
"Weight",
|
||||
"Region",
|
||||
"GeoLocation",
|
||||
"Failover",
|
||||
"TTL",
|
||||
"ResourceRecords",
|
||||
|
|
@ -2224,6 +2828,550 @@
|
|||
"start_record_identifier"
|
||||
]
|
||||
}
|
||||
},
|
||||
"ListTagsForResource": {
|
||||
"name": "ListTagsForResource",
|
||||
"http": {
|
||||
"method": "GET",
|
||||
"uri": "/2013-04-01/tags/{ResourceType}/{ResourceId}"
|
||||
},
|
||||
"input": {
|
||||
"shape_name": "ListTagsForResourceRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ResourceType": {
|
||||
"shape_name": "TagResourceType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"healthcheck"
|
||||
],
|
||||
"documentation": "\n <p>The type of the resource. The resource type for health checks is <code>healthcheck</code>.</p>\n ",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
},
|
||||
"ResourceId": {
|
||||
"shape_name": "TagResourceId",
|
||||
"type": "string",
|
||||
"max_length": 64,
|
||||
"documentation": "\n <p>The ID of the resource for which you want to retrieve tags.</p>\n ",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"ResourceType",
|
||||
"ResourceId"
|
||||
],
|
||||
"documentation": "\n <p>A complex type containing information about a request for a list of the tags that are associated with an individual resource.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ListTagsForResourceResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ResourceTagSet": {
|
||||
"shape_name": "ResourceTagSet",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ResourceType": {
|
||||
"shape_name": "TagResourceType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"healthcheck"
|
||||
],
|
||||
"documentation": "\n <p>The type of the resource. The resource type for health checks is <code>healthcheck</code>.</p>\n "
|
||||
},
|
||||
"ResourceId": {
|
||||
"shape_name": "TagResourceId",
|
||||
"type": "string",
|
||||
"max_length": 64,
|
||||
"documentation": "\n <p>The ID for the specified resource.</p>\n "
|
||||
},
|
||||
"Tags": {
|
||||
"shape_name": "TagList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Tag",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Key": {
|
||||
"shape_name": "TagKey",
|
||||
"type": "string",
|
||||
"max_length": 128,
|
||||
"documentation": "\n <p>The key for a <code>Tag</code>.</p>\n "
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "TagValue",
|
||||
"type": "string",
|
||||
"max_length": 256,
|
||||
"documentation": "\n <p>The value for a <code>Tag</code>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A single tag containing a key and value.</p>\n ",
|
||||
"xmlname": "Tag"
|
||||
},
|
||||
"min_length": 1,
|
||||
"max_length": 10,
|
||||
"documentation": "\n <p>The tags associated with the specified resource.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A <code>ResourceTagSet</code> containing tags associated with the specified resource.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"ResourceTagSet"
|
||||
],
|
||||
"documentation": "\n <p>A complex type containing tags for the specified resource.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Descriptive message for the error response.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Some value specified in the request is invalid or the XML document is malformed.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "NoSuchHealthCheck",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Descriptive message for the error response.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The health check you are trying to get or delete does not exist.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "PriorRequestNotComplete",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The request was rejected because Route 53 was still processing a prior request.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "ThrottlingException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": null
|
||||
}
|
||||
],
|
||||
"documentation": null
|
||||
},
|
||||
"ListTagsForResources": {
|
||||
"name": "ListTagsForResources",
|
||||
"http": {
|
||||
"method": "POST",
|
||||
"uri": "/2013-04-01/tags/{ResourceType}"
|
||||
},
|
||||
"input": {
|
||||
"shape_name": "ListTagsForResourcesRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ResourceType": {
|
||||
"shape_name": "TagResourceType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"healthcheck"
|
||||
],
|
||||
"documentation": "\n <p>The type of the resources. The resource type for health checks is <code>healthcheck</code>.</p>\n ",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
},
|
||||
"ResourceIds": {
|
||||
"shape_name": "TagResourceIdList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "TagResourceId",
|
||||
"type": "string",
|
||||
"max_length": 64,
|
||||
"documentation": null,
|
||||
"xmlname": "ResourceId"
|
||||
},
|
||||
"min_length": 1,
|
||||
"max_length": 10,
|
||||
"documentation": "\n <p>A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"ResourceType",
|
||||
"ResourceIds"
|
||||
],
|
||||
"documentation": "\n <p>A complex type containing information about a request for a list of the tags that are associated with up to 10 specified resources.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ListTagsForResourcesResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ResourceTagSets": {
|
||||
"shape_name": "ResourceTagSetList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "ResourceTagSet",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ResourceType": {
|
||||
"shape_name": "TagResourceType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"healthcheck"
|
||||
],
|
||||
"documentation": "\n <p>The type of the resource. The resource type for health checks is <code>healthcheck</code>.</p>\n "
|
||||
},
|
||||
"ResourceId": {
|
||||
"shape_name": "TagResourceId",
|
||||
"type": "string",
|
||||
"max_length": 64,
|
||||
"documentation": "\n <p>The ID for the specified resource.</p>\n "
|
||||
},
|
||||
"Tags": {
|
||||
"shape_name": "TagList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Tag",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Key": {
|
||||
"shape_name": "TagKey",
|
||||
"type": "string",
|
||||
"max_length": 128,
|
||||
"documentation": "\n <p>The key for a <code>Tag</code>.</p>\n "
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "TagValue",
|
||||
"type": "string",
|
||||
"max_length": 256,
|
||||
"documentation": "\n <p>The value for a <code>Tag</code>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A single tag containing a key and value.</p>\n ",
|
||||
"xmlname": "Tag"
|
||||
},
|
||||
"min_length": 1,
|
||||
"max_length": 10,
|
||||
"documentation": "\n <p>The tags associated with the specified resource.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A complex type containing a resource and its associated tags.</p>\n ",
|
||||
"xmlname": "ResourceTagSet"
|
||||
},
|
||||
"documentation": "\n <p>A list of <code>ResourceTagSet</code>s containing tags associated with the specified resources.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"ResourceTagSets"
|
||||
],
|
||||
"documentation": "\n <p>A complex type containing tags for the specified resources.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Descriptive message for the error response.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Some value specified in the request is invalid or the XML document is malformed.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "NoSuchHealthCheck",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Descriptive message for the error response.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The health check you are trying to get or delete does not exist.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "PriorRequestNotComplete",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The request was rejected because Route 53 was still processing a prior request.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "ThrottlingException",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": null
|
||||
}
|
||||
],
|
||||
"documentation": null
|
||||
},
|
||||
"UpdateHealthCheck": {
|
||||
"name": "UpdateHealthCheck",
|
||||
"http": {
|
||||
"method": "POST",
|
||||
"uri": "/2013-04-01/healthcheck/{HealthCheckId}"
|
||||
},
|
||||
"input": {
|
||||
"shape_name": "UpdateHealthCheckRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"HealthCheckId": {
|
||||
"shape_name": "HealthCheckId",
|
||||
"type": "string",
|
||||
"max_length": 64,
|
||||
"documentation": "\n <p>The ID of the health check to update.</p>\n ",
|
||||
"required": true,
|
||||
"location": "uri"
|
||||
},
|
||||
"HealthCheckVersion": {
|
||||
"shape_name": "HealthCheckVersion",
|
||||
"type": "long",
|
||||
"min_length": 1,
|
||||
"documentation": "\n <p>Optional. When you specify a health check version, Route 53 compares this value with the current value in the health check,\n which prevents you from updating the health check when the versions don't match. Using <code>HealthCheckVersion</code> lets you\n prevent overwriting another change to the health check.</p>\n "
|
||||
},
|
||||
"IPAddress": {
|
||||
"shape_name": "IPAddress",
|
||||
"type": "string",
|
||||
"max_length": 15,
|
||||
"pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$",
|
||||
"documentation": "\n <p>The IP address of the resource that you want to check.</p>\n <p>Specify this value only if you want to change it.</p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Port",
|
||||
"type": "integer",
|
||||
"min_length": 1,
|
||||
"max_length": 65535,
|
||||
"documentation": "\n <p>The port on which you want Route 53 to open a connection to perform health checks.</p>\n <p>Specify this value only if you want to change it.</p>\n "
|
||||
},
|
||||
"ResourcePath": {
|
||||
"shape_name": "ResourcePath",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n <p>The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for\n which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the\n file /docs/route53-health-check.html. </p>\n <p>Specify this value only if you want to change it.</p>\n "
|
||||
},
|
||||
"FullyQualifiedDomainName": {
|
||||
"shape_name": "FullyQualifiedDomainName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n <p>Fully qualified domain name of the instance to be health checked.</p>\n <p>Specify this value only if you want to change it.</p>\n "
|
||||
},
|
||||
"SearchString": {
|
||||
"shape_name": "SearchString",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n <p>If the value of <code>Type</code> is <code>HTTP_STR_MATCH</code> or <code>HTTP_STR_MATCH</code>, the string\n that you want Route 53 to search for in the response body from the specified resource. If the string appears\n in the response body, Route 53 considers the resource healthy. </p>\n <p>Specify this value only if you want to change it.</p>\n "
|
||||
},
|
||||
"FailureThreshold": {
|
||||
"shape_name": "FailureThreshold",
|
||||
"type": "integer",
|
||||
"min_length": 1,
|
||||
"max_length": 10,
|
||||
"documentation": "\n <p>The number of consecutive health checks that an endpoint must pass or fail for Route 53 to\n change the current status of the endpoint from unhealthy to healthy or vice versa.</p>\n <p>Valid values are integers between 1 and 10. For more information,\n see \"How Amazon Route 53 Determines Whether an Endpoint Is Healthy\" in the\n Amazon Route 53 Developer Guide.</p>\n <p>Specify this value only if you want to change it.</p>\n "
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"HealthCheckId",
|
||||
"HealthCheckVersion",
|
||||
"IPAddress",
|
||||
"Port",
|
||||
"ResourcePath",
|
||||
"FullyQualifiedDomainName",
|
||||
"SearchString",
|
||||
"FailureThreshold"
|
||||
],
|
||||
"documentation": "\n <p>>A complex type that contains information about the request to update a health check.</p>\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "UpdateHealthCheckResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"HealthCheck": {
|
||||
"shape_name": "HealthCheck",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Id": {
|
||||
"shape_name": "HealthCheckId",
|
||||
"type": "string",
|
||||
"max_length": 64,
|
||||
"documentation": "\n <p>The ID of the specified health check.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"CallerReference": {
|
||||
"shape_name": "HealthCheckNonce",
|
||||
"type": "string",
|
||||
"min_length": 1,
|
||||
"max_length": 64,
|
||||
"documentation": "\n <p>A unique string that identifies the request to create the health check.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"HealthCheckConfig": {
|
||||
"shape_name": "HealthCheckConfig",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"IPAddress": {
|
||||
"shape_name": "IPAddress",
|
||||
"type": "string",
|
||||
"max_length": 15,
|
||||
"pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$",
|
||||
"documentation": "\n <p>IP Address of the instance being checked. </p>\n "
|
||||
},
|
||||
"Port": {
|
||||
"shape_name": "Port",
|
||||
"type": "integer",
|
||||
"min_length": 1,
|
||||
"max_length": 65535,
|
||||
"documentation": "\n <p>Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.</p>\n "
|
||||
},
|
||||
"Type": {
|
||||
"shape_name": "HealthCheckType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"HTTP",
|
||||
"HTTPS",
|
||||
"HTTP_STR_MATCH",
|
||||
"HTTPS_STR_MATCH",
|
||||
"TCP"
|
||||
],
|
||||
"documentation": "\n <p>The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"ResourcePath": {
|
||||
"shape_name": "ResourcePath",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n <p>Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.</p>\n "
|
||||
},
|
||||
"FullyQualifiedDomainName": {
|
||||
"shape_name": "FullyQualifiedDomainName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n <p>Fully qualified domain name of the instance to be health checked.</p>\n "
|
||||
},
|
||||
"SearchString": {
|
||||
"shape_name": "SearchString",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n <p>A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.</p>\n "
|
||||
},
|
||||
"RequestInterval": {
|
||||
"shape_name": "RequestInterval",
|
||||
"type": "integer",
|
||||
"min_length": 10,
|
||||
"max_length": 30,
|
||||
"documentation": "\n <p>The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.</p>\n <p>Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.</p>\n "
|
||||
},
|
||||
"FailureThreshold": {
|
||||
"shape_name": "FailureThreshold",
|
||||
"type": "integer",
|
||||
"min_length": 1,
|
||||
"max_length": 10,
|
||||
"documentation": "\n <p>The number of consecutive health checks that an endpoint must pass or fail for Route 53 to\n change the current status of the endpoint from unhealthy to healthy or vice versa.</p>\n <p>Valid values are integers between 1 and 10. For more information,\n see \"How Amazon Route 53 Determines Whether an Endpoint Is Healthy\" in the\n Amazon Route 53 Developer Guide.</p>\n "
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"IPAddress",
|
||||
"Port",
|
||||
"Type",
|
||||
"ResourcePath",
|
||||
"FullyQualifiedDomainName",
|
||||
"SearchString",
|
||||
"RequestInterval",
|
||||
"FailureThreshold"
|
||||
],
|
||||
"documentation": "\n <p>A complex type that contains the health check configuration.</p>\n ",
|
||||
"required": true
|
||||
},
|
||||
"HealthCheckVersion": {
|
||||
"shape_name": "HealthCheckVersion",
|
||||
"type": "long",
|
||||
"min_length": 1,
|
||||
"documentation": "\n <p>The version of the health check. You can optionally pass this value in a call to <code>UpdateHealthCheck</code> to\n prevent overwriting another change to the health check.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"Id",
|
||||
"CallerReference",
|
||||
"HealthCheckConfig",
|
||||
"HealthCheckVersion"
|
||||
],
|
||||
"documentation": "\n <p>A complex type that contains identifying information about the health check.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"member_order": [
|
||||
"HealthCheck"
|
||||
],
|
||||
"documentation": null
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "NoSuchHealthCheck",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Descriptive message for the error response.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The health check you are trying to get or delete does not exist.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "InvalidInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>Descriptive message for the error response.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Some value specified in the request is invalid or the XML document is malformed.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "HealthCheckVersionMismatch",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": null
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p> This action updates an existing health check.</p>\n <p> To update a health check, send a <code>POST</code> request to the <code>2013-05-27/healthcheck/<i>health check ID</i></code> resource. The request body must include an XML document with an <code>UpdateHealthCheckRequest</code> element. The response returns an <code>UpdateHealthCheckResponse</code> element, which contains metadata about the health check.</p>\n "
|
||||
}
|
||||
},
|
||||
"pagination": {
|
||||
|
|
|
|||
5803
botocore/data/aws/route53domains/2014-05-15.json
Normal file
5803
botocore/data/aws/route53domains/2014-05-15.json
Normal file
|
|
@ -0,0 +1,5803 @@
|
|||
{
|
||||
"api_version": "2014-05-15",
|
||||
"service_full_name": "Amazon Route 53 Domains",
|
||||
"type": "json",
|
||||
"json_version": "1.1",
|
||||
"signature_version": "v4",
|
||||
"endpoint_prefix": "route53domains",
|
||||
"target_prefix": "Route53Domains_v20140515",
|
||||
"xmlnamespace": "https://route53domains.amazonaws.com/doc/2014-05-15/",
|
||||
"documentation": null,
|
||||
"operations": {
|
||||
"CheckDomainAvailability": {
|
||||
"name": "CheckDomainAvailability",
|
||||
"input": {
|
||||
"shape_name": "CheckDomainAvailabilityRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"DomainName": {
|
||||
"shape_name": "DomainName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"pattern": "[a-zA-Z0-9_\\-.]*",
|
||||
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"IdnLangCode": {
|
||||
"shape_name": "LangCode",
|
||||
"type": "string",
|
||||
"max_length": 3,
|
||||
"documentation": "\n<p>Reserved for future use.</p>\n"
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The CheckDomainAvailability request contains the following elements.</p>\n"
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "CheckDomainAvailabilityResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Availability": {
|
||||
"shape_name": "DomainAvailability",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"AVAILABLE",
|
||||
"AVAILABLE_RESERVED",
|
||||
"AVAILABLE_PREORDER",
|
||||
"UNAVAILABLE",
|
||||
"UNAVAILABLE_PREMIUM",
|
||||
"UNAVAILABLE_RESTRICTED",
|
||||
"RESERVED"
|
||||
],
|
||||
"documentation": "\n<p>Whether the domain name is available for registering.</p>\n<note>\n<p>You can only register domains designated as <code>AVAILABLE</code>.</p>\n</note>\n<p>Type: String</p>\n<p>Valid values:</p>\n<ul>\n<li>\n<code>AVAILABLE</code> \u2013 The domain name is available.</li>\n<li>\n<code>AVAILABLE_RESERVED</code> \u2013 The domain name is reserved under specific conditions.</li>\n<li>\n<code>AVAILABLE_PREORDER</code> \u2013 The domain name is available and can be preordered.</li>\n<li>\n<code>UNAVAILABLE</code> \u2013 The domain name is not available.</li>\n<li>\n<code>UNAVAILABLE_PREMIUM</code> \u2013 The domain name is not available.</li>\n<li>\n<code>UNAVAILABLE_RESTRICTED</code> \u2013 The domain name is forbidden.</li>\n<li>\n<code>RESERVED</code> \u2013 The domain name has been reserved for another person or organization.</li>\n</ul>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The CheckDomainAvailability response includes the following elements.</p>\n"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "UnsupportedTLD",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Amazon Route 53 does not support this top-level domain.</p>\n"
|
||||
}
|
||||
],
|
||||
"documentation": "\n<p>This operation checks the availability of one domain name. You can access this API without authenticating. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.</p>\n<examples>\n <example>\n<name>CheckDomainAvailability Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205225Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.CheckDomainAvailability\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json- 1.1\ncontent-length:[number of characters in the JSON string]\nconnections:Keep-Alive\n{\n \"DomainName\":\"example.com\"\n}</request>\n <response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n \"Availability\":\"AVAILABLE\"\n}</response>\n </example>\n</examples>\n"
|
||||
},
|
||||
"DisableDomainTransferLock": {
|
||||
"name": "DisableDomainTransferLock",
|
||||
"input": {
|
||||
"shape_name": "DisableDomainTransferLockRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"DomainName": {
|
||||
"shape_name": "DomainName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"pattern": "[a-zA-Z0-9_\\-.]*",
|
||||
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The DisableDomainTransferLock request includes the following element.</p>\n"
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "DisableDomainTransferLockResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"OperationId": {
|
||||
"shape_name": "OperationId",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.</p>\n <p>Type: String</p>\n <p>Default: None</p>\n <p>Constraints: Maximum 255 characters.</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The DisableDomainTransferLock response includes the following element.</p>\n"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "DuplicateRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The request is already in progress for the domain.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "TLDRulesViolation",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The top-level domain does not support this operation.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "OperationLimitExceeded",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The number of operations or jobs running exceeded the allowed threshold for the account.</p>\n"
|
||||
}
|
||||
],
|
||||
"documentation": "\n<p>This operation removes the transfer lock on the domain (specifically the\n<code>clientTransferProhibited</code> status) to allow domain transfers. We recommend\nyou refrain from performing this action unless you intend to transfer the domain to a\ndifferent registrar. Successful submission returns an operation ID that you can use to track\nthe progress and completion of the action. If the request is not completed successfully, the\ndomain registrant will be notified by email.</p>\n\n<examples>\n<example>\n<name>DisableDomainTransferLock Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.DisableDomainTransferLock\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n\"DomainName\":\"example.com\"\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n\"OperationId\":\"0b370c79-faa4-40fe-94c8-b423069de3f6\"\n}</response>\n</example>\n</examples>\n"
|
||||
},
|
||||
"EnableDomainTransferLock": {
|
||||
"name": "EnableDomainTransferLock",
|
||||
"input": {
|
||||
"shape_name": "EnableDomainTransferLockRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"DomainName": {
|
||||
"shape_name": "DomainName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"pattern": "[a-zA-Z0-9_\\-.]*",
|
||||
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The EnableDomainTransferLock request includes the following element.</p>\n"
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "EnableDomainTransferLockResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"OperationId": {
|
||||
"shape_name": "OperationId",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.</p>\n <p>Type: String</p>\n <p>Default: None</p>\n <p>Constraints: Maximum 255 characters.</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The EnableDomainTransferLock response includes the following elements.</p>\n"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "DuplicateRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The request is already in progress for the domain.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "TLDRulesViolation",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The top-level domain does not support this operation.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "OperationLimitExceeded",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The number of operations or jobs running exceeded the allowed threshold for the account.</p>\n"
|
||||
}
|
||||
],
|
||||
"documentation": "\n<p>This operation sets the transfer lock on the domain (specifically the\n<code>clientTransferProhibited</code> status) to prevent domain transfers. Successful submission\nreturns an operation ID that you can use to track the progress and completion of the action. If the\nrequest is not completed successfully, the domain registrant will be notified by email.</p>\n<examples>\n<example>\n<name>EnableDomainTransferLock Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.EnableDomainTransferLock\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"DomainName\":\"example.com\"\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n \"OperationId\":\"0b370c79-faa4-40fe-94c8-b423069de3f6\"\n}</response>\n</example>\n</examples>\n"
|
||||
},
|
||||
"GetDomainDetail": {
|
||||
"name": "GetDomainDetail",
|
||||
"input": {
|
||||
"shape_name": "GetDomainDetailRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"DomainName": {
|
||||
"shape_name": "DomainName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"pattern": "[a-zA-Z0-9_\\-.]*",
|
||||
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The GetDomainDetail request includes the following element.</p>\n"
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "GetDomainDetailResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"DomainName": {
|
||||
"shape_name": "DomainName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"pattern": "[a-zA-Z0-9_\\-.]*",
|
||||
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"Nameservers": {
|
||||
"shape_name": "NameserverList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Nameserver",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "HostName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"pattern": "[a-zA-Z0-9_\\-.]*",
|
||||
"documentation": "\n<p>The fully qualified host name of the name server.</p>\n<p>Type: String</p>\n<p>Constraint: Maximum 255 characterss</p>\n<p>Parent: <code>Nameservers</code></p>\n",
|
||||
"required": true
|
||||
},
|
||||
"GlueIps": {
|
||||
"shape_name": "GlueIpList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "GlueIp",
|
||||
"type": "string",
|
||||
"max_length": 45,
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "\n<p>Glue IP address of a name server entry. Glue IP addresses are required only when the name of the\nname server is a subdomain of the domain. For example, if your domain is example.com and the name\nserver for the domain is ns.example.com, you need to specify the IP address for ns.example.com.</p>\n<p>Type: List of IP addresses.</p>\n<p>Constraints: The list can contain only one IPv4 and one IPv6 address.</p>\n<p>Parent: <code>Nameservers</code></p>\n"
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>Nameserver includes the following elements.</p>\n"
|
||||
},
|
||||
"documentation": "\n<p>The name of the domain.</p>\n<p>Type: String</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"AutoRenew": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n<p>Specifies whether the domain registration is set to renew automatically.</p>\n<p>Type: Boolean</p>\n"
|
||||
},
|
||||
"AdminContact": {
|
||||
"shape_name": "ContactDetail",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FirstName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"LastName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ContactType": {
|
||||
"shape_name": "ContactType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"PERSON",
|
||||
"COMPANY",
|
||||
"ASSOCIATION",
|
||||
"PUBLIC_BODY",
|
||||
"RESELLER"
|
||||
],
|
||||
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"OrganizationName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"AddressLine1": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"AddressLine2": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"City": {
|
||||
"shape_name": "City",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"State": {
|
||||
"shape_name": "State",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"CountryCode": {
|
||||
"shape_name": "CountryCode",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"AD",
|
||||
"AE",
|
||||
"AF",
|
||||
"AG",
|
||||
"AI",
|
||||
"AL",
|
||||
"AM",
|
||||
"AN",
|
||||
"AO",
|
||||
"AQ",
|
||||
"AR",
|
||||
"AS",
|
||||
"AT",
|
||||
"AU",
|
||||
"AW",
|
||||
"AZ",
|
||||
"BA",
|
||||
"BB",
|
||||
"BD",
|
||||
"BE",
|
||||
"BF",
|
||||
"BG",
|
||||
"BH",
|
||||
"BI",
|
||||
"BJ",
|
||||
"BL",
|
||||
"BM",
|
||||
"BN",
|
||||
"BO",
|
||||
"BR",
|
||||
"BS",
|
||||
"BT",
|
||||
"BW",
|
||||
"BY",
|
||||
"BZ",
|
||||
"CA",
|
||||
"CC",
|
||||
"CD",
|
||||
"CF",
|
||||
"CG",
|
||||
"CH",
|
||||
"CI",
|
||||
"CK",
|
||||
"CL",
|
||||
"CM",
|
||||
"CN",
|
||||
"CO",
|
||||
"CR",
|
||||
"CU",
|
||||
"CV",
|
||||
"CX",
|
||||
"CY",
|
||||
"CZ",
|
||||
"DE",
|
||||
"DJ",
|
||||
"DK",
|
||||
"DM",
|
||||
"DO",
|
||||
"DZ",
|
||||
"EC",
|
||||
"EE",
|
||||
"EG",
|
||||
"ER",
|
||||
"ES",
|
||||
"ET",
|
||||
"FI",
|
||||
"FJ",
|
||||
"FK",
|
||||
"FM",
|
||||
"FO",
|
||||
"FR",
|
||||
"GA",
|
||||
"GB",
|
||||
"GD",
|
||||
"GE",
|
||||
"GH",
|
||||
"GI",
|
||||
"GL",
|
||||
"GM",
|
||||
"GN",
|
||||
"GQ",
|
||||
"GR",
|
||||
"GT",
|
||||
"GU",
|
||||
"GW",
|
||||
"GY",
|
||||
"HK",
|
||||
"HN",
|
||||
"HR",
|
||||
"HT",
|
||||
"HU",
|
||||
"ID",
|
||||
"IE",
|
||||
"IL",
|
||||
"IM",
|
||||
"IN",
|
||||
"IQ",
|
||||
"IR",
|
||||
"IS",
|
||||
"IT",
|
||||
"JM",
|
||||
"JO",
|
||||
"JP",
|
||||
"KE",
|
||||
"KG",
|
||||
"KH",
|
||||
"KI",
|
||||
"KM",
|
||||
"KN",
|
||||
"KP",
|
||||
"KR",
|
||||
"KW",
|
||||
"KY",
|
||||
"KZ",
|
||||
"LA",
|
||||
"LB",
|
||||
"LC",
|
||||
"LI",
|
||||
"LK",
|
||||
"LR",
|
||||
"LS",
|
||||
"LT",
|
||||
"LU",
|
||||
"LV",
|
||||
"LY",
|
||||
"MA",
|
||||
"MC",
|
||||
"MD",
|
||||
"ME",
|
||||
"MF",
|
||||
"MG",
|
||||
"MH",
|
||||
"MK",
|
||||
"ML",
|
||||
"MM",
|
||||
"MN",
|
||||
"MO",
|
||||
"MP",
|
||||
"MR",
|
||||
"MS",
|
||||
"MT",
|
||||
"MU",
|
||||
"MV",
|
||||
"MW",
|
||||
"MX",
|
||||
"MY",
|
||||
"MZ",
|
||||
"NA",
|
||||
"NC",
|
||||
"NE",
|
||||
"NG",
|
||||
"NI",
|
||||
"NL",
|
||||
"NO",
|
||||
"NP",
|
||||
"NR",
|
||||
"NU",
|
||||
"NZ",
|
||||
"OM",
|
||||
"PA",
|
||||
"PE",
|
||||
"PF",
|
||||
"PG",
|
||||
"PH",
|
||||
"PK",
|
||||
"PL",
|
||||
"PM",
|
||||
"PN",
|
||||
"PR",
|
||||
"PT",
|
||||
"PW",
|
||||
"PY",
|
||||
"QA",
|
||||
"RO",
|
||||
"RS",
|
||||
"RU",
|
||||
"RW",
|
||||
"SA",
|
||||
"SB",
|
||||
"SC",
|
||||
"SD",
|
||||
"SE",
|
||||
"SG",
|
||||
"SH",
|
||||
"SI",
|
||||
"SK",
|
||||
"SL",
|
||||
"SM",
|
||||
"SN",
|
||||
"SO",
|
||||
"SR",
|
||||
"ST",
|
||||
"SV",
|
||||
"SY",
|
||||
"SZ",
|
||||
"TC",
|
||||
"TD",
|
||||
"TG",
|
||||
"TH",
|
||||
"TJ",
|
||||
"TK",
|
||||
"TL",
|
||||
"TM",
|
||||
"TN",
|
||||
"TO",
|
||||
"TR",
|
||||
"TT",
|
||||
"TV",
|
||||
"TW",
|
||||
"TZ",
|
||||
"UA",
|
||||
"UG",
|
||||
"US",
|
||||
"UY",
|
||||
"UZ",
|
||||
"VA",
|
||||
"VC",
|
||||
"VE",
|
||||
"VG",
|
||||
"VI",
|
||||
"VN",
|
||||
"VU",
|
||||
"WF",
|
||||
"WS",
|
||||
"YE",
|
||||
"YT",
|
||||
"ZA",
|
||||
"ZM",
|
||||
"ZW"
|
||||
],
|
||||
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ZipCode": {
|
||||
"shape_name": "ZipCode",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"PhoneNumber": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Email": {
|
||||
"shape_name": "Email",
|
||||
"type": "string",
|
||||
"max_length": 254,
|
||||
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Fax": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"ExtraParams": {
|
||||
"shape_name": "ExtraParamList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "ExtraParam",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "ExtraParamName",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DUNS_NUMBER",
|
||||
"BRAND_NUMBER",
|
||||
"BIRTH_DEPARTMENT",
|
||||
"BIRTH_DATE_IN_YYYY_MM_DD",
|
||||
"BIRTH_COUNTRY",
|
||||
"BIRTH_CITY",
|
||||
"DOCUMENT_NUMBER",
|
||||
"AU_ID_NUMBER",
|
||||
"AU_ID_TYPE",
|
||||
"CA_LEGAL_TYPE",
|
||||
"FI_BUSINESS_NUMBER",
|
||||
"FI_ID_NUMBER",
|
||||
"IT_PIN",
|
||||
"RU_PASSPORT_DATA",
|
||||
"SE_ID_NUMBER",
|
||||
"SG_ID_NUMBER",
|
||||
"VAT_NUMBER"
|
||||
],
|
||||
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "ExtraParamValue",
|
||||
"type": "string",
|
||||
"max_length": 2048,
|
||||
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
||||
},
|
||||
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
||||
}
|
||||
},
|
||||
"sensitive": true,
|
||||
"documentation": "\n<p>Provides details about the domain administrative contact. </p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>,\n<code>LastName</code>, <code>ContactType</code>,\n<code>OrganizationName</code>, <code>AddressLine1</code>,\n<code>AddressLine2</code>, <code>City</code>, <code>State</code>,\n<code>CountryCode</code>, <code>ZipCode</code>,\n<code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>,\n<code>ExtraParams</code></p>\n",
|
||||
"required": true
|
||||
},
|
||||
"RegistrantContact": {
|
||||
"shape_name": "ContactDetail",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FirstName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"LastName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ContactType": {
|
||||
"shape_name": "ContactType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"PERSON",
|
||||
"COMPANY",
|
||||
"ASSOCIATION",
|
||||
"PUBLIC_BODY",
|
||||
"RESELLER"
|
||||
],
|
||||
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"OrganizationName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"AddressLine1": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"AddressLine2": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"City": {
|
||||
"shape_name": "City",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"State": {
|
||||
"shape_name": "State",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"CountryCode": {
|
||||
"shape_name": "CountryCode",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"AD",
|
||||
"AE",
|
||||
"AF",
|
||||
"AG",
|
||||
"AI",
|
||||
"AL",
|
||||
"AM",
|
||||
"AN",
|
||||
"AO",
|
||||
"AQ",
|
||||
"AR",
|
||||
"AS",
|
||||
"AT",
|
||||
"AU",
|
||||
"AW",
|
||||
"AZ",
|
||||
"BA",
|
||||
"BB",
|
||||
"BD",
|
||||
"BE",
|
||||
"BF",
|
||||
"BG",
|
||||
"BH",
|
||||
"BI",
|
||||
"BJ",
|
||||
"BL",
|
||||
"BM",
|
||||
"BN",
|
||||
"BO",
|
||||
"BR",
|
||||
"BS",
|
||||
"BT",
|
||||
"BW",
|
||||
"BY",
|
||||
"BZ",
|
||||
"CA",
|
||||
"CC",
|
||||
"CD",
|
||||
"CF",
|
||||
"CG",
|
||||
"CH",
|
||||
"CI",
|
||||
"CK",
|
||||
"CL",
|
||||
"CM",
|
||||
"CN",
|
||||
"CO",
|
||||
"CR",
|
||||
"CU",
|
||||
"CV",
|
||||
"CX",
|
||||
"CY",
|
||||
"CZ",
|
||||
"DE",
|
||||
"DJ",
|
||||
"DK",
|
||||
"DM",
|
||||
"DO",
|
||||
"DZ",
|
||||
"EC",
|
||||
"EE",
|
||||
"EG",
|
||||
"ER",
|
||||
"ES",
|
||||
"ET",
|
||||
"FI",
|
||||
"FJ",
|
||||
"FK",
|
||||
"FM",
|
||||
"FO",
|
||||
"FR",
|
||||
"GA",
|
||||
"GB",
|
||||
"GD",
|
||||
"GE",
|
||||
"GH",
|
||||
"GI",
|
||||
"GL",
|
||||
"GM",
|
||||
"GN",
|
||||
"GQ",
|
||||
"GR",
|
||||
"GT",
|
||||
"GU",
|
||||
"GW",
|
||||
"GY",
|
||||
"HK",
|
||||
"HN",
|
||||
"HR",
|
||||
"HT",
|
||||
"HU",
|
||||
"ID",
|
||||
"IE",
|
||||
"IL",
|
||||
"IM",
|
||||
"IN",
|
||||
"IQ",
|
||||
"IR",
|
||||
"IS",
|
||||
"IT",
|
||||
"JM",
|
||||
"JO",
|
||||
"JP",
|
||||
"KE",
|
||||
"KG",
|
||||
"KH",
|
||||
"KI",
|
||||
"KM",
|
||||
"KN",
|
||||
"KP",
|
||||
"KR",
|
||||
"KW",
|
||||
"KY",
|
||||
"KZ",
|
||||
"LA",
|
||||
"LB",
|
||||
"LC",
|
||||
"LI",
|
||||
"LK",
|
||||
"LR",
|
||||
"LS",
|
||||
"LT",
|
||||
"LU",
|
||||
"LV",
|
||||
"LY",
|
||||
"MA",
|
||||
"MC",
|
||||
"MD",
|
||||
"ME",
|
||||
"MF",
|
||||
"MG",
|
||||
"MH",
|
||||
"MK",
|
||||
"ML",
|
||||
"MM",
|
||||
"MN",
|
||||
"MO",
|
||||
"MP",
|
||||
"MR",
|
||||
"MS",
|
||||
"MT",
|
||||
"MU",
|
||||
"MV",
|
||||
"MW",
|
||||
"MX",
|
||||
"MY",
|
||||
"MZ",
|
||||
"NA",
|
||||
"NC",
|
||||
"NE",
|
||||
"NG",
|
||||
"NI",
|
||||
"NL",
|
||||
"NO",
|
||||
"NP",
|
||||
"NR",
|
||||
"NU",
|
||||
"NZ",
|
||||
"OM",
|
||||
"PA",
|
||||
"PE",
|
||||
"PF",
|
||||
"PG",
|
||||
"PH",
|
||||
"PK",
|
||||
"PL",
|
||||
"PM",
|
||||
"PN",
|
||||
"PR",
|
||||
"PT",
|
||||
"PW",
|
||||
"PY",
|
||||
"QA",
|
||||
"RO",
|
||||
"RS",
|
||||
"RU",
|
||||
"RW",
|
||||
"SA",
|
||||
"SB",
|
||||
"SC",
|
||||
"SD",
|
||||
"SE",
|
||||
"SG",
|
||||
"SH",
|
||||
"SI",
|
||||
"SK",
|
||||
"SL",
|
||||
"SM",
|
||||
"SN",
|
||||
"SO",
|
||||
"SR",
|
||||
"ST",
|
||||
"SV",
|
||||
"SY",
|
||||
"SZ",
|
||||
"TC",
|
||||
"TD",
|
||||
"TG",
|
||||
"TH",
|
||||
"TJ",
|
||||
"TK",
|
||||
"TL",
|
||||
"TM",
|
||||
"TN",
|
||||
"TO",
|
||||
"TR",
|
||||
"TT",
|
||||
"TV",
|
||||
"TW",
|
||||
"TZ",
|
||||
"UA",
|
||||
"UG",
|
||||
"US",
|
||||
"UY",
|
||||
"UZ",
|
||||
"VA",
|
||||
"VC",
|
||||
"VE",
|
||||
"VG",
|
||||
"VI",
|
||||
"VN",
|
||||
"VU",
|
||||
"WF",
|
||||
"WS",
|
||||
"YE",
|
||||
"YT",
|
||||
"ZA",
|
||||
"ZM",
|
||||
"ZW"
|
||||
],
|
||||
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ZipCode": {
|
||||
"shape_name": "ZipCode",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"PhoneNumber": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Email": {
|
||||
"shape_name": "Email",
|
||||
"type": "string",
|
||||
"max_length": 254,
|
||||
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Fax": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"ExtraParams": {
|
||||
"shape_name": "ExtraParamList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "ExtraParam",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "ExtraParamName",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DUNS_NUMBER",
|
||||
"BRAND_NUMBER",
|
||||
"BIRTH_DEPARTMENT",
|
||||
"BIRTH_DATE_IN_YYYY_MM_DD",
|
||||
"BIRTH_COUNTRY",
|
||||
"BIRTH_CITY",
|
||||
"DOCUMENT_NUMBER",
|
||||
"AU_ID_NUMBER",
|
||||
"AU_ID_TYPE",
|
||||
"CA_LEGAL_TYPE",
|
||||
"FI_BUSINESS_NUMBER",
|
||||
"FI_ID_NUMBER",
|
||||
"IT_PIN",
|
||||
"RU_PASSPORT_DATA",
|
||||
"SE_ID_NUMBER",
|
||||
"SG_ID_NUMBER",
|
||||
"VAT_NUMBER"
|
||||
],
|
||||
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "ExtraParamValue",
|
||||
"type": "string",
|
||||
"max_length": 2048,
|
||||
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
||||
},
|
||||
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
||||
}
|
||||
},
|
||||
"sensitive": true,
|
||||
"documentation": "\n<p>Provides details about the domain registrant. </p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>,\n<code>LastName</code>, <code>ContactType</code>,\n<code>OrganizationName</code>, <code>AddressLine1</code>,\n<code>AddressLine2</code>, <code>City</code>, <code>State</code>,\n<code>CountryCode</code>, <code>ZipCode</code>,\n<code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>,\n<code>ExtraParams</code></p>\n",
|
||||
"required": true
|
||||
},
|
||||
"TechContact": {
|
||||
"shape_name": "ContactDetail",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FirstName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"LastName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ContactType": {
|
||||
"shape_name": "ContactType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"PERSON",
|
||||
"COMPANY",
|
||||
"ASSOCIATION",
|
||||
"PUBLIC_BODY",
|
||||
"RESELLER"
|
||||
],
|
||||
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"OrganizationName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"AddressLine1": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"AddressLine2": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"City": {
|
||||
"shape_name": "City",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"State": {
|
||||
"shape_name": "State",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"CountryCode": {
|
||||
"shape_name": "CountryCode",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"AD",
|
||||
"AE",
|
||||
"AF",
|
||||
"AG",
|
||||
"AI",
|
||||
"AL",
|
||||
"AM",
|
||||
"AN",
|
||||
"AO",
|
||||
"AQ",
|
||||
"AR",
|
||||
"AS",
|
||||
"AT",
|
||||
"AU",
|
||||
"AW",
|
||||
"AZ",
|
||||
"BA",
|
||||
"BB",
|
||||
"BD",
|
||||
"BE",
|
||||
"BF",
|
||||
"BG",
|
||||
"BH",
|
||||
"BI",
|
||||
"BJ",
|
||||
"BL",
|
||||
"BM",
|
||||
"BN",
|
||||
"BO",
|
||||
"BR",
|
||||
"BS",
|
||||
"BT",
|
||||
"BW",
|
||||
"BY",
|
||||
"BZ",
|
||||
"CA",
|
||||
"CC",
|
||||
"CD",
|
||||
"CF",
|
||||
"CG",
|
||||
"CH",
|
||||
"CI",
|
||||
"CK",
|
||||
"CL",
|
||||
"CM",
|
||||
"CN",
|
||||
"CO",
|
||||
"CR",
|
||||
"CU",
|
||||
"CV",
|
||||
"CX",
|
||||
"CY",
|
||||
"CZ",
|
||||
"DE",
|
||||
"DJ",
|
||||
"DK",
|
||||
"DM",
|
||||
"DO",
|
||||
"DZ",
|
||||
"EC",
|
||||
"EE",
|
||||
"EG",
|
||||
"ER",
|
||||
"ES",
|
||||
"ET",
|
||||
"FI",
|
||||
"FJ",
|
||||
"FK",
|
||||
"FM",
|
||||
"FO",
|
||||
"FR",
|
||||
"GA",
|
||||
"GB",
|
||||
"GD",
|
||||
"GE",
|
||||
"GH",
|
||||
"GI",
|
||||
"GL",
|
||||
"GM",
|
||||
"GN",
|
||||
"GQ",
|
||||
"GR",
|
||||
"GT",
|
||||
"GU",
|
||||
"GW",
|
||||
"GY",
|
||||
"HK",
|
||||
"HN",
|
||||
"HR",
|
||||
"HT",
|
||||
"HU",
|
||||
"ID",
|
||||
"IE",
|
||||
"IL",
|
||||
"IM",
|
||||
"IN",
|
||||
"IQ",
|
||||
"IR",
|
||||
"IS",
|
||||
"IT",
|
||||
"JM",
|
||||
"JO",
|
||||
"JP",
|
||||
"KE",
|
||||
"KG",
|
||||
"KH",
|
||||
"KI",
|
||||
"KM",
|
||||
"KN",
|
||||
"KP",
|
||||
"KR",
|
||||
"KW",
|
||||
"KY",
|
||||
"KZ",
|
||||
"LA",
|
||||
"LB",
|
||||
"LC",
|
||||
"LI",
|
||||
"LK",
|
||||
"LR",
|
||||
"LS",
|
||||
"LT",
|
||||
"LU",
|
||||
"LV",
|
||||
"LY",
|
||||
"MA",
|
||||
"MC",
|
||||
"MD",
|
||||
"ME",
|
||||
"MF",
|
||||
"MG",
|
||||
"MH",
|
||||
"MK",
|
||||
"ML",
|
||||
"MM",
|
||||
"MN",
|
||||
"MO",
|
||||
"MP",
|
||||
"MR",
|
||||
"MS",
|
||||
"MT",
|
||||
"MU",
|
||||
"MV",
|
||||
"MW",
|
||||
"MX",
|
||||
"MY",
|
||||
"MZ",
|
||||
"NA",
|
||||
"NC",
|
||||
"NE",
|
||||
"NG",
|
||||
"NI",
|
||||
"NL",
|
||||
"NO",
|
||||
"NP",
|
||||
"NR",
|
||||
"NU",
|
||||
"NZ",
|
||||
"OM",
|
||||
"PA",
|
||||
"PE",
|
||||
"PF",
|
||||
"PG",
|
||||
"PH",
|
||||
"PK",
|
||||
"PL",
|
||||
"PM",
|
||||
"PN",
|
||||
"PR",
|
||||
"PT",
|
||||
"PW",
|
||||
"PY",
|
||||
"QA",
|
||||
"RO",
|
||||
"RS",
|
||||
"RU",
|
||||
"RW",
|
||||
"SA",
|
||||
"SB",
|
||||
"SC",
|
||||
"SD",
|
||||
"SE",
|
||||
"SG",
|
||||
"SH",
|
||||
"SI",
|
||||
"SK",
|
||||
"SL",
|
||||
"SM",
|
||||
"SN",
|
||||
"SO",
|
||||
"SR",
|
||||
"ST",
|
||||
"SV",
|
||||
"SY",
|
||||
"SZ",
|
||||
"TC",
|
||||
"TD",
|
||||
"TG",
|
||||
"TH",
|
||||
"TJ",
|
||||
"TK",
|
||||
"TL",
|
||||
"TM",
|
||||
"TN",
|
||||
"TO",
|
||||
"TR",
|
||||
"TT",
|
||||
"TV",
|
||||
"TW",
|
||||
"TZ",
|
||||
"UA",
|
||||
"UG",
|
||||
"US",
|
||||
"UY",
|
||||
"UZ",
|
||||
"VA",
|
||||
"VC",
|
||||
"VE",
|
||||
"VG",
|
||||
"VI",
|
||||
"VN",
|
||||
"VU",
|
||||
"WF",
|
||||
"WS",
|
||||
"YE",
|
||||
"YT",
|
||||
"ZA",
|
||||
"ZM",
|
||||
"ZW"
|
||||
],
|
||||
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ZipCode": {
|
||||
"shape_name": "ZipCode",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"PhoneNumber": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Email": {
|
||||
"shape_name": "Email",
|
||||
"type": "string",
|
||||
"max_length": 254,
|
||||
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Fax": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"ExtraParams": {
|
||||
"shape_name": "ExtraParamList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "ExtraParam",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "ExtraParamName",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DUNS_NUMBER",
|
||||
"BRAND_NUMBER",
|
||||
"BIRTH_DEPARTMENT",
|
||||
"BIRTH_DATE_IN_YYYY_MM_DD",
|
||||
"BIRTH_COUNTRY",
|
||||
"BIRTH_CITY",
|
||||
"DOCUMENT_NUMBER",
|
||||
"AU_ID_NUMBER",
|
||||
"AU_ID_TYPE",
|
||||
"CA_LEGAL_TYPE",
|
||||
"FI_BUSINESS_NUMBER",
|
||||
"FI_ID_NUMBER",
|
||||
"IT_PIN",
|
||||
"RU_PASSPORT_DATA",
|
||||
"SE_ID_NUMBER",
|
||||
"SG_ID_NUMBER",
|
||||
"VAT_NUMBER"
|
||||
],
|
||||
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "ExtraParamValue",
|
||||
"type": "string",
|
||||
"max_length": 2048,
|
||||
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
||||
},
|
||||
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
||||
}
|
||||
},
|
||||
"sensitive": true,
|
||||
"documentation": "\n<p>Provides details about the domain technical contact.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>,\n<code>LastName</code>, <code>ContactType</code>,\n<code>OrganizationName</code>, <code>AddressLine1</code>,\n<code>AddressLine2</code>, <code>City</code>, <code>State</code>,\n<code>CountryCode</code>, <code>ZipCode</code>,\n<code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>,\n<code>ExtraParams</code></p>\n",
|
||||
"required": true
|
||||
},
|
||||
"AdminPrivacy": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n<p>Specifies whether contact information for the admin contact is concealed from WHOIS queries.\nIf the value is <code>true</code>, WHOIS (\"who is\") queries will return contact information for our\nregistrar partner, Gandi, instead of the contact information that you enter.</p>\n<p>Type: Boolean</p>\n"
|
||||
},
|
||||
"RegistrantPrivacy": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n<p>Specifies whether contact information for the registrant contact is concealed from WHOIS queries.\nIf the value is <code>true</code>, WHOIS (\"who is\") queries will return contact information for our\nregistrar partner, Gandi, instead of the contact information that you enter.</p>\n<p>Type: Boolean</p>\n"
|
||||
},
|
||||
"TechPrivacy": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n<p>Specifies whether contact information for the tech contact is concealed from WHOIS queries.\nIf the value is <code>true</code>, WHOIS (\"who is\") queries will return contact information for our\nregistrar partner, Gandi, instead of the contact information that you enter.</p>\n<p>Type: Boolean</p>\n"
|
||||
},
|
||||
"RegistrarName": {
|
||||
"shape_name": "RegistrarName",
|
||||
"type": "string",
|
||||
"documentation": "\n<p>Name of the registrar of the domain as identified in the registry. Amazon Route 53 domains are registered by registrar Gandi.\nThe value is <code>\"GANDI SAS\"</code>. </p>\n<p>Type: String</p>\n"
|
||||
},
|
||||
"WhoIsServer": {
|
||||
"shape_name": "RegistrarWhoIsServer",
|
||||
"type": "string",
|
||||
"documentation": "\n<p>The fully qualified name of the WHOIS server that can answer the WHOIS query for the\ndomain.</p>\n<p>Type: String</p>\n"
|
||||
},
|
||||
"RegistrarUrl": {
|
||||
"shape_name": "RegistrarUrl",
|
||||
"type": "string",
|
||||
"documentation": "\n<p>Web address of the registrar.</p>\n<p>Type: String</p>\n"
|
||||
},
|
||||
"AbuseContactEmail": {
|
||||
"shape_name": "Email",
|
||||
"type": "string",
|
||||
"max_length": 254,
|
||||
"documentation": "\n<p>Email address to contact to report incorrect contact information for a domain, to report that the domain\nis being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type\nof abuse. </p>\n<p>Type: String</p>\n"
|
||||
},
|
||||
"AbuseContactPhone": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>Phone number for reporting abuse. </p>\n<p>Type: String</p>\n"
|
||||
},
|
||||
"RegistryDomainId": {
|
||||
"shape_name": "RegistryDomainId",
|
||||
"type": "string",
|
||||
"documentation": "\n<p>Reserved for future use.</p>\n"
|
||||
},
|
||||
"CreationDate": {
|
||||
"shape_name": "Timestamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n<p>The date when the domain was created as found in the response to a WHOIS query. The date\nformat is Unix time.</p>\n"
|
||||
},
|
||||
"UpdatedDate": {
|
||||
"shape_name": "Timestamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n<p>The last updated date of the domain as found in the response to a WHOIS query. The date\nformat is Unix time.</p>\n"
|
||||
},
|
||||
"ExpirationDate": {
|
||||
"shape_name": "Timestamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n<p>The date when the registration for the domain is set to expire. The date format is Unix time.</p>\n"
|
||||
},
|
||||
"Reseller": {
|
||||
"shape_name": "Reseller",
|
||||
"type": "string",
|
||||
"documentation": "\n<p>Reseller of the domain. Domains registered or transferred using Amazon Route 53 domains will have\n<code>\"Amazon\"</code> as the reseller. </p>\n<p>Type: String</p>\n"
|
||||
},
|
||||
"DnsSec": {
|
||||
"shape_name": "DNSSec",
|
||||
"type": "string",
|
||||
"documentation": "\n<p>Reserved for future use.</p>\n"
|
||||
},
|
||||
"StatusList": {
|
||||
"shape_name": "DomainStatusList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "DomainStatus",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "\n<p>An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.</p>\n<p>ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes\nthat tell you the status of a variety of operations on a domain name, for example, registering a domain name,\ntransferring a domain name to another registrar, renewing the registration for a domain name, and so on.\nAll registrars use this same set of status codes.</p>\n<p>For a current list of domain name status codes and an explanation of what each code means, go to the\n<a href=\"https://www.icann.org/\">ICANN website</a> and search for <code>epp status codes</code>.\n(Search on the ICANN website; web searches sometimes return an old version of the document.)</p>\n<p>Type: Array of String</p>\n"
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The GetDomainDetail response includes the following elements.</p>\n"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.</p>\n"
|
||||
}
|
||||
],
|
||||
"documentation": "\n<p>This operation returns detailed information about the domain. The domain's contact information is also returned as part of the output.</p>\n<examples>\n<example>\n<name>GetDomainDetail Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.GetDomainDetail\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"DomainName\":\"example.com\"\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n \"AbuseContactEmail\":\"abuse@support.gandi.net\",\n \"AbuseContactPhone\":\"+33.170377661\",\n \"AdminContact\":{\n \"AddressLine1\":\"1 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Anytown\",\n \"CountryCode\":\"US\",\n \"Email\":\"john@example.com\",\n \"ExtraParams\":[\n ],\n \"FirstName\":\"John\",\n \"LastName\":\"Doe\",\n \"PhoneNumber\":\"+2065550100\",\n \"State\":\"WA\",\n \"ZipCode\":\"98101\"\n },\n \"AdminPrivacy\":true,\n \"AutoRenew\":true,\n \"CreationDate\":1400010459,\n \"DomainName\":\"example.com\",\n \"ExpirationDate\":1431539259,\n \"Nameservers\":[\n {\n \"GlueIps\":[\n ],\n \"Name\":\"ns-2048.awsdns-64.com\"\n },\n {\n \"GlueIps\":[\n ],\n \"Name\":\"ns-2051.awsdns-67.co.uk\"\n },\n {\n \"GlueIps\":[\n ],\n \"Name\":\"ns-2050.awsdns-66.org\"\n },\n {\n \"GlueIps\":[\n ],\n \"Name\":\"ns-2049.awsdns-65.net\"\n }\n ],\n \"RegistrantContact\":{\n \"AddressLine1\":\"1 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Anytown\",\n \"CountryCode\":\"US\",\n \"Email\":\"john@example.com\",\n \"ExtraParams\":[\n ],\n \"FirstName\":\"John\",\n \"LastName\":\"Doe\",\n \"PhoneNumber\":\"+2065550100\",\n \"State\":\"WA\",\n \"ZipCode\":\"98101\"\n },\n \"RegistrantPrivacy\":true,\n \"RegistrarName\":\"GANDI SAS\",\n \"RegistrarUrl\":\"http://www.gandi.net\",\n \"Reseller\":\"Amazon\",\n \"StatusList\":[\n \"clientTransferProhibited\"\n ],\n \"TechContact\":{\n \"AddressLine1\":\"1 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Anytown\",\n \"CountryCode\":\"US\",\n \"Email\":\"john@example.com\",\n \"ExtraParams\":[\n ],\n \"FirstName\":\"John\",\n \"LastName\":\"Doe\",\n \"PhoneNumber\":\"+2065550100\",\n \"State\":\"WA\",\n \"ZipCode\":\"98101\"\n },\n \"TechPrivacy\":true,\n \"UpdatedDate\":1400010459,\n \"WhoIsServer\":\"whois.gandi.net\"\n}</response>\n</example>\n</examples>\n"
|
||||
},
|
||||
"GetOperationDetail": {
|
||||
"name": "GetOperationDetail",
|
||||
"input": {
|
||||
"shape_name": "GetOperationDetailRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"OperationId": {
|
||||
"shape_name": "OperationId",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier\nin the response to the original request.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The GetOperationDetail request includes the following element.</p>\n"
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "GetOperationDetailResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"OperationId": {
|
||||
"shape_name": "OperationId",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The identifier for the operation.</p>\n<p>Type: String</p>\n"
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "OperationStatus",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"SUBMITTED",
|
||||
"IN_PROGRESS",
|
||||
"ERROR",
|
||||
"SUCCESSFUL",
|
||||
"FAILED"
|
||||
],
|
||||
"documentation": "\n<p>The current status of the requested operation in the system.</p>\n<p>Type: String</p>\n"
|
||||
},
|
||||
"Message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n<p>Detailed information on the status including possible errors.</p>\n<p>Type: String</p>\n"
|
||||
},
|
||||
"DomainName": {
|
||||
"shape_name": "DomainName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"pattern": "[a-zA-Z0-9_\\-.]*",
|
||||
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n"
|
||||
},
|
||||
"Type": {
|
||||
"shape_name": "OperationType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"REGISTER_DOMAIN",
|
||||
"DELETE_DOMAIN",
|
||||
"TRANSFER_IN_DOMAIN",
|
||||
"UPDATE_DOMAIN_CONTACT",
|
||||
"UPDATE_NAMESERVER",
|
||||
"CHANGE_PRIVACY_PROTECTION",
|
||||
"DOMAIN_LOCK"
|
||||
],
|
||||
"documentation": "\n<p>The type of operation that was requested.</p>\n<p>Type: String</p>\n"
|
||||
},
|
||||
"SubmittedDate": {
|
||||
"shape_name": "Timestamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n<p>The date when the request was submitted.</p>\n"
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The GetOperationDetail response includes the following elements.</p>\n"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.</p>\n"
|
||||
}
|
||||
],
|
||||
"documentation": "\n<p>This operation returns the current status of an operation that is not completed.</p>\n<examples>\n<example>\n<name>GetOperationDetail Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.GetOperationDetail\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"OperationId\":\"43884ce5-e30a-4801-858f-7aa86356c127\"\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n \"DomainName\":\"happierdomain.ca\",\n \"OperationId\":\"43884ce5-e30a-4801-858f-7aa86356c127\",\n \"Status\":\"WORKFLOW_IN_PROGRESS\",\n \"SubmittedDate\" : 1402630939.057,\n \"Type\" : \"REGISTER_DOMAIN\"\n}</response>\n</example>\n</examples>\n"
|
||||
},
|
||||
"ListDomains": {
|
||||
"name": "ListDomains",
|
||||
"input": {
|
||||
"shape_name": "ListDomainsRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Marker": {
|
||||
"shape_name": "PageMarker",
|
||||
"type": "string",
|
||||
"max_length": 4096,
|
||||
"documentation": "\n<p>For an initial request for a list of domains, omit this element. If the number of domains\nthat are associated with the current AWS account is greater than the value that you specified for\n<code>MaxItems</code>, you can use <code>Marker</code> to return additional domains. Get the value of\n<code>NextPageMarker</code> from the previous response, and submit another request that includes the\nvalue of <code>NextPageMarker</code> in the <code>Marker</code> element.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: The marker must match the value specified in the previous request. </p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"MaxItems": {
|
||||
"shape_name": "PageMaxItems",
|
||||
"type": "integer",
|
||||
"max_length": 100,
|
||||
"documentation": "\n<p>Number of domains to be returned.</p>\n<p>Type: Integer</p>\n<p>Default: 20</p>\n<p>Constraints: A numeral between 1 and 100.</p>\n<p>Required: No</p>\n"
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The ListDomains request includes the following elements.</p>\n"
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ListDomainsResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Domains": {
|
||||
"shape_name": "DomainSummaryList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "DomainSummary",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"DomainName": {
|
||||
"shape_name": "DomainName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"pattern": "[a-zA-Z0-9_\\-.]*",
|
||||
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"AutoRenew": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n<p>Indicates whether the domain is automatically renewed upon expiration.</p>\n<p>Type: Boolean</p>\n<p>Valid values: <code>True</code> | <code>False</code></p>\n"
|
||||
},
|
||||
"TransferLock": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n<p>Indicates whether a domain is locked from unauthorized transfer to another party.</p>\n<p>Type: Boolean</p>\n<p>Valid values: <code>True</code> | <code>False</code></p>\n"
|
||||
},
|
||||
"Expiry": {
|
||||
"shape_name": "Timestamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n<p>Expiration date of the domain in Coordinated Universal Time (UTC).</p>\n<p>Type: Long</p>\n"
|
||||
}
|
||||
},
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "\n<p>A summary of domains.</p>\n<p>Type: Complex type containing a list of domain summaries.</p>\n<p>Children: <code>AutoRenew</code>, <code>DomainName</code>,\n<code>Expiry</code>, <code>TransferLock</code></p>\n",
|
||||
"required": true
|
||||
},
|
||||
"NextPageMarker": {
|
||||
"shape_name": "PageMarker",
|
||||
"type": "string",
|
||||
"max_length": 4096,
|
||||
"documentation": "\n<p>If there are more domains than you specified for <code>MaxItems</code> in the request, submit another\nrequest and include the value of <code>NextPageMarker</code> in the value of <code>Marker</code>.</p>\n<p>Type: String</p>\n<p>Parent: <code>Operations</code></p>\n"
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The ListDomains response includes the following elements.</p>\n"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.</p>\n"
|
||||
}
|
||||
],
|
||||
"documentation": "\n<p>This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.</p>\n<examples>\n<example>\n<name>ListDomains Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.ListDomains\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"Marker\":\"AxDAClaROQAXasf29GHWAIKPLA=\",\n \"MaxItems\":20\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n \"Domains\":[\n {\n \"AutoRenew\":false,\n \"DomainName\":\"example.com\",\n \"Expiry\":1431203765,\n \"TransferLock\":false\n },\n {\n \"AutoRenew\":false,\n \"DomainName\":\"example.net\",\n \"Expiry\":1431539260,\n \"TransferLock\":false\n },\n {\n \"AutoRenew\":false,\n \"DomainName\":\"example.org\",\n \"Expiry\":1431240024,\n \"TransferLock\":false\n },\n {\n \"AutoRenew\":false,\n \"DomainName\":\"example.test\",\n \"Expiry\":1431539259,\n \"TransferLock\":false\n }\n ]\n}</response>\n</example>\n</examples>\n"
|
||||
},
|
||||
"ListOperations": {
|
||||
"name": "ListOperations",
|
||||
"input": {
|
||||
"shape_name": "ListOperationsRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Marker": {
|
||||
"shape_name": "PageMarker",
|
||||
"type": "string",
|
||||
"max_length": 4096,
|
||||
"documentation": "\n<p>For an initial request for a list of operations, omit this element. If the number of operations that are\nnot yet complete is greater than the value that you specified for <code>MaxItems</code>, you can use <code>Marker</code>\nto return additional operations. Get the value of <code>NextPageMarker</code> from the previous response,\nand submit another request that includes the value of <code>NextPageMarker</code> in the <code>Marker</code> element.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"MaxItems": {
|
||||
"shape_name": "PageMaxItems",
|
||||
"type": "integer",
|
||||
"max_length": 100,
|
||||
"documentation": "\n<p>Number of domains to be returned.</p>\n<p>Type: Integer</p>\n<p>Default: 20</p>\n<p>Constraints: A value between 1 and 100.</p>\n<p>Required: No</p>\n"
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The ListOperations request includes the following elements.</p>\n"
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "ListOperationsResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Operations": {
|
||||
"shape_name": "OperationSummaryList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "OperationSummary",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"OperationId": {
|
||||
"shape_name": "OperationId",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Identifier returned to track the requested action.</p>\n<p>Type: String</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"Status": {
|
||||
"shape_name": "OperationStatus",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"SUBMITTED",
|
||||
"IN_PROGRESS",
|
||||
"ERROR",
|
||||
"SUCCESSFUL",
|
||||
"FAILED"
|
||||
],
|
||||
"documentation": "\n<p>The current status of the requested operation in the system.</p>\n<p>Type: String</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"Type": {
|
||||
"shape_name": "OperationType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"REGISTER_DOMAIN",
|
||||
"DELETE_DOMAIN",
|
||||
"TRANSFER_IN_DOMAIN",
|
||||
"UPDATE_DOMAIN_CONTACT",
|
||||
"UPDATE_NAMESERVER",
|
||||
"CHANGE_PRIVACY_PROTECTION",
|
||||
"DOMAIN_LOCK"
|
||||
],
|
||||
"documentation": "\n<p>Type of the action requested.</p>\n<p>Type: String</p>\n<p>Valid values: <code>REGISTER_DOMAIN</code> | <code>DELETE_DOMAIN</code> | <code>TRANSFER_IN_DOMAIN</code> | <code>UPDATE_DOMAIN_CONTACT</code> | <code>UPDATE_NAMESERVER</code> | <code>CHANGE_PRIVACY_PROTECTION</code> | <code>DOMAIN_LOCK</code></p>\n",
|
||||
"required": true
|
||||
},
|
||||
"SubmittedDate": {
|
||||
"shape_name": "Timestamp",
|
||||
"type": "timestamp",
|
||||
"documentation": "\n<p>The date when the request was submitted.</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>OperationSummary includes the following elements.</p>\n"
|
||||
},
|
||||
"documentation": "\n<p>Lists summaries of the operations.</p>\n<p>Type: Complex type containing a list of operation summaries</p>\n<p>Children: <code>OperationId</code>, <code>Status</code>, <code>SubmittedDate</code>,\n<code>Type</code></p>\n",
|
||||
"required": true
|
||||
},
|
||||
"NextPageMarker": {
|
||||
"shape_name": "PageMarker",
|
||||
"type": "string",
|
||||
"max_length": 4096,
|
||||
"documentation": "\n<p>If there are more operations than you specified for <code>MaxItems</code> in the request, submit another\nrequest and include the value of <code>NextPageMarker</code> in the value of <code>Marker</code>.</p>\n<p>Type: String</p>\n<p>Parent: <code>Operations</code></p>\n"
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The ListOperations response includes the following elements.</p>\n"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.</p>\n"
|
||||
}
|
||||
],
|
||||
"documentation": "\n<p>This operation returns the operation IDs of operations that are not yet complete.</p>\n<examples>\n<example>\n<name>ListOperations Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.ListOperations\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"MaxItems\" : 2\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n \"Operations\":[\n {\n \"OperationId\":\"4ced3d4a-e011-45ee-b94f-1e2d73477562\",\n \"Status\":\"WORKFLOW_IN_PROGRESS\",\n \"SubmittedDate\":1403548979.088,\n \"Type\":\"CHANGE_PRIVACY_PROTECTION\"\n },\n {\n \"OperationId\":\"2e3ac45b-89b3-47ea-a042-f56dcd1b6883\",\n \"Status\":\"WORKFLOW_IN_PROGRESS\",\n \"SubmittedDate\":1403548986.429,\n \"Type\":\"DOMAIN_LOCK\"\n }\n ]\n}</response>\n</example>\n</examples>\n"
|
||||
},
|
||||
"RegisterDomain": {
|
||||
"name": "RegisterDomain",
|
||||
"input": {
|
||||
"shape_name": "RegisterDomainRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"DomainName": {
|
||||
"shape_name": "DomainName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"pattern": "[a-zA-Z0-9_\\-.]*",
|
||||
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"IdnLangCode": {
|
||||
"shape_name": "LangCode",
|
||||
"type": "string",
|
||||
"max_length": 3,
|
||||
"documentation": "\n<p>Reserved for future use.</p>\n"
|
||||
},
|
||||
"DurationInYears": {
|
||||
"shape_name": "DurationInYears",
|
||||
"type": "integer",
|
||||
"min_length": 1,
|
||||
"max_length": 10,
|
||||
"documentation": "\n<p>The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.</p>\n<p>Type: Integer</p>\n<p>Default: 1</p>\n<p>Valid values: Integer from 1 to 10</p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"AutoRenew": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n<p>Indicates whether the domain will be automatically renewed (<code>true</code>) or not (<code>false</code>). Autorenewal only takes effect after the account is charged.</p>\n<p>Type: Boolean</p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Default: <code>true</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"AdminContact": {
|
||||
"shape_name": "ContactDetail",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FirstName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"LastName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ContactType": {
|
||||
"shape_name": "ContactType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"PERSON",
|
||||
"COMPANY",
|
||||
"ASSOCIATION",
|
||||
"PUBLIC_BODY",
|
||||
"RESELLER"
|
||||
],
|
||||
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"OrganizationName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"AddressLine1": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"AddressLine2": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"City": {
|
||||
"shape_name": "City",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"State": {
|
||||
"shape_name": "State",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"CountryCode": {
|
||||
"shape_name": "CountryCode",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"AD",
|
||||
"AE",
|
||||
"AF",
|
||||
"AG",
|
||||
"AI",
|
||||
"AL",
|
||||
"AM",
|
||||
"AN",
|
||||
"AO",
|
||||
"AQ",
|
||||
"AR",
|
||||
"AS",
|
||||
"AT",
|
||||
"AU",
|
||||
"AW",
|
||||
"AZ",
|
||||
"BA",
|
||||
"BB",
|
||||
"BD",
|
||||
"BE",
|
||||
"BF",
|
||||
"BG",
|
||||
"BH",
|
||||
"BI",
|
||||
"BJ",
|
||||
"BL",
|
||||
"BM",
|
||||
"BN",
|
||||
"BO",
|
||||
"BR",
|
||||
"BS",
|
||||
"BT",
|
||||
"BW",
|
||||
"BY",
|
||||
"BZ",
|
||||
"CA",
|
||||
"CC",
|
||||
"CD",
|
||||
"CF",
|
||||
"CG",
|
||||
"CH",
|
||||
"CI",
|
||||
"CK",
|
||||
"CL",
|
||||
"CM",
|
||||
"CN",
|
||||
"CO",
|
||||
"CR",
|
||||
"CU",
|
||||
"CV",
|
||||
"CX",
|
||||
"CY",
|
||||
"CZ",
|
||||
"DE",
|
||||
"DJ",
|
||||
"DK",
|
||||
"DM",
|
||||
"DO",
|
||||
"DZ",
|
||||
"EC",
|
||||
"EE",
|
||||
"EG",
|
||||
"ER",
|
||||
"ES",
|
||||
"ET",
|
||||
"FI",
|
||||
"FJ",
|
||||
"FK",
|
||||
"FM",
|
||||
"FO",
|
||||
"FR",
|
||||
"GA",
|
||||
"GB",
|
||||
"GD",
|
||||
"GE",
|
||||
"GH",
|
||||
"GI",
|
||||
"GL",
|
||||
"GM",
|
||||
"GN",
|
||||
"GQ",
|
||||
"GR",
|
||||
"GT",
|
||||
"GU",
|
||||
"GW",
|
||||
"GY",
|
||||
"HK",
|
||||
"HN",
|
||||
"HR",
|
||||
"HT",
|
||||
"HU",
|
||||
"ID",
|
||||
"IE",
|
||||
"IL",
|
||||
"IM",
|
||||
"IN",
|
||||
"IQ",
|
||||
"IR",
|
||||
"IS",
|
||||
"IT",
|
||||
"JM",
|
||||
"JO",
|
||||
"JP",
|
||||
"KE",
|
||||
"KG",
|
||||
"KH",
|
||||
"KI",
|
||||
"KM",
|
||||
"KN",
|
||||
"KP",
|
||||
"KR",
|
||||
"KW",
|
||||
"KY",
|
||||
"KZ",
|
||||
"LA",
|
||||
"LB",
|
||||
"LC",
|
||||
"LI",
|
||||
"LK",
|
||||
"LR",
|
||||
"LS",
|
||||
"LT",
|
||||
"LU",
|
||||
"LV",
|
||||
"LY",
|
||||
"MA",
|
||||
"MC",
|
||||
"MD",
|
||||
"ME",
|
||||
"MF",
|
||||
"MG",
|
||||
"MH",
|
||||
"MK",
|
||||
"ML",
|
||||
"MM",
|
||||
"MN",
|
||||
"MO",
|
||||
"MP",
|
||||
"MR",
|
||||
"MS",
|
||||
"MT",
|
||||
"MU",
|
||||
"MV",
|
||||
"MW",
|
||||
"MX",
|
||||
"MY",
|
||||
"MZ",
|
||||
"NA",
|
||||
"NC",
|
||||
"NE",
|
||||
"NG",
|
||||
"NI",
|
||||
"NL",
|
||||
"NO",
|
||||
"NP",
|
||||
"NR",
|
||||
"NU",
|
||||
"NZ",
|
||||
"OM",
|
||||
"PA",
|
||||
"PE",
|
||||
"PF",
|
||||
"PG",
|
||||
"PH",
|
||||
"PK",
|
||||
"PL",
|
||||
"PM",
|
||||
"PN",
|
||||
"PR",
|
||||
"PT",
|
||||
"PW",
|
||||
"PY",
|
||||
"QA",
|
||||
"RO",
|
||||
"RS",
|
||||
"RU",
|
||||
"RW",
|
||||
"SA",
|
||||
"SB",
|
||||
"SC",
|
||||
"SD",
|
||||
"SE",
|
||||
"SG",
|
||||
"SH",
|
||||
"SI",
|
||||
"SK",
|
||||
"SL",
|
||||
"SM",
|
||||
"SN",
|
||||
"SO",
|
||||
"SR",
|
||||
"ST",
|
||||
"SV",
|
||||
"SY",
|
||||
"SZ",
|
||||
"TC",
|
||||
"TD",
|
||||
"TG",
|
||||
"TH",
|
||||
"TJ",
|
||||
"TK",
|
||||
"TL",
|
||||
"TM",
|
||||
"TN",
|
||||
"TO",
|
||||
"TR",
|
||||
"TT",
|
||||
"TV",
|
||||
"TW",
|
||||
"TZ",
|
||||
"UA",
|
||||
"UG",
|
||||
"US",
|
||||
"UY",
|
||||
"UZ",
|
||||
"VA",
|
||||
"VC",
|
||||
"VE",
|
||||
"VG",
|
||||
"VI",
|
||||
"VN",
|
||||
"VU",
|
||||
"WF",
|
||||
"WS",
|
||||
"YE",
|
||||
"YT",
|
||||
"ZA",
|
||||
"ZM",
|
||||
"ZW"
|
||||
],
|
||||
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ZipCode": {
|
||||
"shape_name": "ZipCode",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"PhoneNumber": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Email": {
|
||||
"shape_name": "Email",
|
||||
"type": "string",
|
||||
"max_length": 254,
|
||||
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Fax": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"ExtraParams": {
|
||||
"shape_name": "ExtraParamList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "ExtraParam",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "ExtraParamName",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DUNS_NUMBER",
|
||||
"BRAND_NUMBER",
|
||||
"BIRTH_DEPARTMENT",
|
||||
"BIRTH_DATE_IN_YYYY_MM_DD",
|
||||
"BIRTH_COUNTRY",
|
||||
"BIRTH_CITY",
|
||||
"DOCUMENT_NUMBER",
|
||||
"AU_ID_NUMBER",
|
||||
"AU_ID_TYPE",
|
||||
"CA_LEGAL_TYPE",
|
||||
"FI_BUSINESS_NUMBER",
|
||||
"FI_ID_NUMBER",
|
||||
"IT_PIN",
|
||||
"RU_PASSPORT_DATA",
|
||||
"SE_ID_NUMBER",
|
||||
"SG_ID_NUMBER",
|
||||
"VAT_NUMBER"
|
||||
],
|
||||
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "ExtraParamValue",
|
||||
"type": "string",
|
||||
"max_length": 2048,
|
||||
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
||||
},
|
||||
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
||||
}
|
||||
},
|
||||
"sensitive": true,
|
||||
"documentation": "\n<p>Provides detailed contact information.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>, <code>LastName</code>, <code>ContactType</code>, <code>OrganizationName</code>, <code>AddressLine1</code>, <code>AddressLine2</code>, <code>City</code>, <code>State</code>, <code>CountryCode</code>, <code>ZipCode</code>, <code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>, <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"RegistrantContact": {
|
||||
"shape_name": "ContactDetail",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FirstName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"LastName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ContactType": {
|
||||
"shape_name": "ContactType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"PERSON",
|
||||
"COMPANY",
|
||||
"ASSOCIATION",
|
||||
"PUBLIC_BODY",
|
||||
"RESELLER"
|
||||
],
|
||||
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"OrganizationName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"AddressLine1": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"AddressLine2": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"City": {
|
||||
"shape_name": "City",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"State": {
|
||||
"shape_name": "State",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"CountryCode": {
|
||||
"shape_name": "CountryCode",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"AD",
|
||||
"AE",
|
||||
"AF",
|
||||
"AG",
|
||||
"AI",
|
||||
"AL",
|
||||
"AM",
|
||||
"AN",
|
||||
"AO",
|
||||
"AQ",
|
||||
"AR",
|
||||
"AS",
|
||||
"AT",
|
||||
"AU",
|
||||
"AW",
|
||||
"AZ",
|
||||
"BA",
|
||||
"BB",
|
||||
"BD",
|
||||
"BE",
|
||||
"BF",
|
||||
"BG",
|
||||
"BH",
|
||||
"BI",
|
||||
"BJ",
|
||||
"BL",
|
||||
"BM",
|
||||
"BN",
|
||||
"BO",
|
||||
"BR",
|
||||
"BS",
|
||||
"BT",
|
||||
"BW",
|
||||
"BY",
|
||||
"BZ",
|
||||
"CA",
|
||||
"CC",
|
||||
"CD",
|
||||
"CF",
|
||||
"CG",
|
||||
"CH",
|
||||
"CI",
|
||||
"CK",
|
||||
"CL",
|
||||
"CM",
|
||||
"CN",
|
||||
"CO",
|
||||
"CR",
|
||||
"CU",
|
||||
"CV",
|
||||
"CX",
|
||||
"CY",
|
||||
"CZ",
|
||||
"DE",
|
||||
"DJ",
|
||||
"DK",
|
||||
"DM",
|
||||
"DO",
|
||||
"DZ",
|
||||
"EC",
|
||||
"EE",
|
||||
"EG",
|
||||
"ER",
|
||||
"ES",
|
||||
"ET",
|
||||
"FI",
|
||||
"FJ",
|
||||
"FK",
|
||||
"FM",
|
||||
"FO",
|
||||
"FR",
|
||||
"GA",
|
||||
"GB",
|
||||
"GD",
|
||||
"GE",
|
||||
"GH",
|
||||
"GI",
|
||||
"GL",
|
||||
"GM",
|
||||
"GN",
|
||||
"GQ",
|
||||
"GR",
|
||||
"GT",
|
||||
"GU",
|
||||
"GW",
|
||||
"GY",
|
||||
"HK",
|
||||
"HN",
|
||||
"HR",
|
||||
"HT",
|
||||
"HU",
|
||||
"ID",
|
||||
"IE",
|
||||
"IL",
|
||||
"IM",
|
||||
"IN",
|
||||
"IQ",
|
||||
"IR",
|
||||
"IS",
|
||||
"IT",
|
||||
"JM",
|
||||
"JO",
|
||||
"JP",
|
||||
"KE",
|
||||
"KG",
|
||||
"KH",
|
||||
"KI",
|
||||
"KM",
|
||||
"KN",
|
||||
"KP",
|
||||
"KR",
|
||||
"KW",
|
||||
"KY",
|
||||
"KZ",
|
||||
"LA",
|
||||
"LB",
|
||||
"LC",
|
||||
"LI",
|
||||
"LK",
|
||||
"LR",
|
||||
"LS",
|
||||
"LT",
|
||||
"LU",
|
||||
"LV",
|
||||
"LY",
|
||||
"MA",
|
||||
"MC",
|
||||
"MD",
|
||||
"ME",
|
||||
"MF",
|
||||
"MG",
|
||||
"MH",
|
||||
"MK",
|
||||
"ML",
|
||||
"MM",
|
||||
"MN",
|
||||
"MO",
|
||||
"MP",
|
||||
"MR",
|
||||
"MS",
|
||||
"MT",
|
||||
"MU",
|
||||
"MV",
|
||||
"MW",
|
||||
"MX",
|
||||
"MY",
|
||||
"MZ",
|
||||
"NA",
|
||||
"NC",
|
||||
"NE",
|
||||
"NG",
|
||||
"NI",
|
||||
"NL",
|
||||
"NO",
|
||||
"NP",
|
||||
"NR",
|
||||
"NU",
|
||||
"NZ",
|
||||
"OM",
|
||||
"PA",
|
||||
"PE",
|
||||
"PF",
|
||||
"PG",
|
||||
"PH",
|
||||
"PK",
|
||||
"PL",
|
||||
"PM",
|
||||
"PN",
|
||||
"PR",
|
||||
"PT",
|
||||
"PW",
|
||||
"PY",
|
||||
"QA",
|
||||
"RO",
|
||||
"RS",
|
||||
"RU",
|
||||
"RW",
|
||||
"SA",
|
||||
"SB",
|
||||
"SC",
|
||||
"SD",
|
||||
"SE",
|
||||
"SG",
|
||||
"SH",
|
||||
"SI",
|
||||
"SK",
|
||||
"SL",
|
||||
"SM",
|
||||
"SN",
|
||||
"SO",
|
||||
"SR",
|
||||
"ST",
|
||||
"SV",
|
||||
"SY",
|
||||
"SZ",
|
||||
"TC",
|
||||
"TD",
|
||||
"TG",
|
||||
"TH",
|
||||
"TJ",
|
||||
"TK",
|
||||
"TL",
|
||||
"TM",
|
||||
"TN",
|
||||
"TO",
|
||||
"TR",
|
||||
"TT",
|
||||
"TV",
|
||||
"TW",
|
||||
"TZ",
|
||||
"UA",
|
||||
"UG",
|
||||
"US",
|
||||
"UY",
|
||||
"UZ",
|
||||
"VA",
|
||||
"VC",
|
||||
"VE",
|
||||
"VG",
|
||||
"VI",
|
||||
"VN",
|
||||
"VU",
|
||||
"WF",
|
||||
"WS",
|
||||
"YE",
|
||||
"YT",
|
||||
"ZA",
|
||||
"ZM",
|
||||
"ZW"
|
||||
],
|
||||
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ZipCode": {
|
||||
"shape_name": "ZipCode",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"PhoneNumber": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Email": {
|
||||
"shape_name": "Email",
|
||||
"type": "string",
|
||||
"max_length": 254,
|
||||
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Fax": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"ExtraParams": {
|
||||
"shape_name": "ExtraParamList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "ExtraParam",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "ExtraParamName",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DUNS_NUMBER",
|
||||
"BRAND_NUMBER",
|
||||
"BIRTH_DEPARTMENT",
|
||||
"BIRTH_DATE_IN_YYYY_MM_DD",
|
||||
"BIRTH_COUNTRY",
|
||||
"BIRTH_CITY",
|
||||
"DOCUMENT_NUMBER",
|
||||
"AU_ID_NUMBER",
|
||||
"AU_ID_TYPE",
|
||||
"CA_LEGAL_TYPE",
|
||||
"FI_BUSINESS_NUMBER",
|
||||
"FI_ID_NUMBER",
|
||||
"IT_PIN",
|
||||
"RU_PASSPORT_DATA",
|
||||
"SE_ID_NUMBER",
|
||||
"SG_ID_NUMBER",
|
||||
"VAT_NUMBER"
|
||||
],
|
||||
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "ExtraParamValue",
|
||||
"type": "string",
|
||||
"max_length": 2048,
|
||||
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
||||
},
|
||||
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
||||
}
|
||||
},
|
||||
"sensitive": true,
|
||||
"documentation": "\n<p>Provides detailed contact information.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>, <code>LastName</code>, <code>ContactType</code>, <code>OrganizationName</code>, <code>AddressLine1</code>, <code>AddressLine2</code>, <code>City</code>, <code>State</code>, <code>CountryCode</code>, <code>ZipCode</code>, <code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>, <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"TechContact": {
|
||||
"shape_name": "ContactDetail",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FirstName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"LastName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ContactType": {
|
||||
"shape_name": "ContactType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"PERSON",
|
||||
"COMPANY",
|
||||
"ASSOCIATION",
|
||||
"PUBLIC_BODY",
|
||||
"RESELLER"
|
||||
],
|
||||
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"OrganizationName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"AddressLine1": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"AddressLine2": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"City": {
|
||||
"shape_name": "City",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"State": {
|
||||
"shape_name": "State",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"CountryCode": {
|
||||
"shape_name": "CountryCode",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"AD",
|
||||
"AE",
|
||||
"AF",
|
||||
"AG",
|
||||
"AI",
|
||||
"AL",
|
||||
"AM",
|
||||
"AN",
|
||||
"AO",
|
||||
"AQ",
|
||||
"AR",
|
||||
"AS",
|
||||
"AT",
|
||||
"AU",
|
||||
"AW",
|
||||
"AZ",
|
||||
"BA",
|
||||
"BB",
|
||||
"BD",
|
||||
"BE",
|
||||
"BF",
|
||||
"BG",
|
||||
"BH",
|
||||
"BI",
|
||||
"BJ",
|
||||
"BL",
|
||||
"BM",
|
||||
"BN",
|
||||
"BO",
|
||||
"BR",
|
||||
"BS",
|
||||
"BT",
|
||||
"BW",
|
||||
"BY",
|
||||
"BZ",
|
||||
"CA",
|
||||
"CC",
|
||||
"CD",
|
||||
"CF",
|
||||
"CG",
|
||||
"CH",
|
||||
"CI",
|
||||
"CK",
|
||||
"CL",
|
||||
"CM",
|
||||
"CN",
|
||||
"CO",
|
||||
"CR",
|
||||
"CU",
|
||||
"CV",
|
||||
"CX",
|
||||
"CY",
|
||||
"CZ",
|
||||
"DE",
|
||||
"DJ",
|
||||
"DK",
|
||||
"DM",
|
||||
"DO",
|
||||
"DZ",
|
||||
"EC",
|
||||
"EE",
|
||||
"EG",
|
||||
"ER",
|
||||
"ES",
|
||||
"ET",
|
||||
"FI",
|
||||
"FJ",
|
||||
"FK",
|
||||
"FM",
|
||||
"FO",
|
||||
"FR",
|
||||
"GA",
|
||||
"GB",
|
||||
"GD",
|
||||
"GE",
|
||||
"GH",
|
||||
"GI",
|
||||
"GL",
|
||||
"GM",
|
||||
"GN",
|
||||
"GQ",
|
||||
"GR",
|
||||
"GT",
|
||||
"GU",
|
||||
"GW",
|
||||
"GY",
|
||||
"HK",
|
||||
"HN",
|
||||
"HR",
|
||||
"HT",
|
||||
"HU",
|
||||
"ID",
|
||||
"IE",
|
||||
"IL",
|
||||
"IM",
|
||||
"IN",
|
||||
"IQ",
|
||||
"IR",
|
||||
"IS",
|
||||
"IT",
|
||||
"JM",
|
||||
"JO",
|
||||
"JP",
|
||||
"KE",
|
||||
"KG",
|
||||
"KH",
|
||||
"KI",
|
||||
"KM",
|
||||
"KN",
|
||||
"KP",
|
||||
"KR",
|
||||
"KW",
|
||||
"KY",
|
||||
"KZ",
|
||||
"LA",
|
||||
"LB",
|
||||
"LC",
|
||||
"LI",
|
||||
"LK",
|
||||
"LR",
|
||||
"LS",
|
||||
"LT",
|
||||
"LU",
|
||||
"LV",
|
||||
"LY",
|
||||
"MA",
|
||||
"MC",
|
||||
"MD",
|
||||
"ME",
|
||||
"MF",
|
||||
"MG",
|
||||
"MH",
|
||||
"MK",
|
||||
"ML",
|
||||
"MM",
|
||||
"MN",
|
||||
"MO",
|
||||
"MP",
|
||||
"MR",
|
||||
"MS",
|
||||
"MT",
|
||||
"MU",
|
||||
"MV",
|
||||
"MW",
|
||||
"MX",
|
||||
"MY",
|
||||
"MZ",
|
||||
"NA",
|
||||
"NC",
|
||||
"NE",
|
||||
"NG",
|
||||
"NI",
|
||||
"NL",
|
||||
"NO",
|
||||
"NP",
|
||||
"NR",
|
||||
"NU",
|
||||
"NZ",
|
||||
"OM",
|
||||
"PA",
|
||||
"PE",
|
||||
"PF",
|
||||
"PG",
|
||||
"PH",
|
||||
"PK",
|
||||
"PL",
|
||||
"PM",
|
||||
"PN",
|
||||
"PR",
|
||||
"PT",
|
||||
"PW",
|
||||
"PY",
|
||||
"QA",
|
||||
"RO",
|
||||
"RS",
|
||||
"RU",
|
||||
"RW",
|
||||
"SA",
|
||||
"SB",
|
||||
"SC",
|
||||
"SD",
|
||||
"SE",
|
||||
"SG",
|
||||
"SH",
|
||||
"SI",
|
||||
"SK",
|
||||
"SL",
|
||||
"SM",
|
||||
"SN",
|
||||
"SO",
|
||||
"SR",
|
||||
"ST",
|
||||
"SV",
|
||||
"SY",
|
||||
"SZ",
|
||||
"TC",
|
||||
"TD",
|
||||
"TG",
|
||||
"TH",
|
||||
"TJ",
|
||||
"TK",
|
||||
"TL",
|
||||
"TM",
|
||||
"TN",
|
||||
"TO",
|
||||
"TR",
|
||||
"TT",
|
||||
"TV",
|
||||
"TW",
|
||||
"TZ",
|
||||
"UA",
|
||||
"UG",
|
||||
"US",
|
||||
"UY",
|
||||
"UZ",
|
||||
"VA",
|
||||
"VC",
|
||||
"VE",
|
||||
"VG",
|
||||
"VI",
|
||||
"VN",
|
||||
"VU",
|
||||
"WF",
|
||||
"WS",
|
||||
"YE",
|
||||
"YT",
|
||||
"ZA",
|
||||
"ZM",
|
||||
"ZW"
|
||||
],
|
||||
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ZipCode": {
|
||||
"shape_name": "ZipCode",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"PhoneNumber": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Email": {
|
||||
"shape_name": "Email",
|
||||
"type": "string",
|
||||
"max_length": 254,
|
||||
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Fax": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"ExtraParams": {
|
||||
"shape_name": "ExtraParamList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "ExtraParam",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "ExtraParamName",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DUNS_NUMBER",
|
||||
"BRAND_NUMBER",
|
||||
"BIRTH_DEPARTMENT",
|
||||
"BIRTH_DATE_IN_YYYY_MM_DD",
|
||||
"BIRTH_COUNTRY",
|
||||
"BIRTH_CITY",
|
||||
"DOCUMENT_NUMBER",
|
||||
"AU_ID_NUMBER",
|
||||
"AU_ID_TYPE",
|
||||
"CA_LEGAL_TYPE",
|
||||
"FI_BUSINESS_NUMBER",
|
||||
"FI_ID_NUMBER",
|
||||
"IT_PIN",
|
||||
"RU_PASSPORT_DATA",
|
||||
"SE_ID_NUMBER",
|
||||
"SG_ID_NUMBER",
|
||||
"VAT_NUMBER"
|
||||
],
|
||||
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "ExtraParamValue",
|
||||
"type": "string",
|
||||
"max_length": 2048,
|
||||
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
||||
},
|
||||
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
||||
}
|
||||
},
|
||||
"sensitive": true,
|
||||
"documentation": "\n<p>Provides detailed contact information.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>, <code>LastName</code>, <code>ContactType</code>, <code>OrganizationName</code>, <code>AddressLine1</code>, <code>AddressLine2</code>, <code>City</code>, <code>State</code>, <code>CountryCode</code>, <code>ZipCode</code>, <code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>, <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"PrivacyProtectAdminContact": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n<p>Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.</p>\n<p>Type: Boolean</p>\n<p>Default: <code>true</code></p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Required: No</p>\n\n"
|
||||
},
|
||||
"PrivacyProtectRegistrantContact": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n<p>Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.</p>\n<p>Type: Boolean</p>\n<p>Default: <code>true</code></p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Required: No</p>\n\n"
|
||||
},
|
||||
"PrivacyProtectTechContact": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n<p>Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.</p>\n<p>Type: Boolean</p>\n<p>Default: <code>true</code></p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Required: No</p>\n\n"
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The RegisterDomain request includes the following elements.</p>\n"
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "RegisterDomainResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"OperationId": {
|
||||
"shape_name": "OperationId",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.</p>\n <p>Type: String</p>\n <p>Default: None</p>\n <p>Constraints: Maximum 255 characters.</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The RegisterDomain response includes the following element.</p>\n"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "UnsupportedTLD",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Amazon Route 53 does not support this top-level domain.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "DuplicateRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The request is already in progress for the domain.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "TLDRulesViolation",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The top-level domain does not support this operation.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "DomainLimitExceeded",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The number of domains has exceeded the allowed threshold for the account.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "OperationLimitExceeded",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The number of operations or jobs running exceeded the allowed threshold for the account.</p>\n"
|
||||
}
|
||||
],
|
||||
"documentation": "\n<p>This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi.\nFor some top-level domains (TLDs), this operation requires extra parameters.</p>\n<p>When you register a domain, Amazon Route 53 does the following:</p>\n<ul>\n<li>Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers\nto your hosted zone and automatically updates your domain registration with the names of these name servers.</li>\n<li>Enables autorenew, so your domain registration will renew automatically each year. We'll notify you\nin advance of the renewal date so you can choose whether to renew the registration.</li>\n<li>Optionally enables privacy protection, so WHOIS queries return contact information for our registrar partner, Gandi,\ninstead of the information you entered for registrant, admin, and tech contacts.</li>\n<li>If registration is successful, returns an operation ID that you can use to track the progress and\ncompletion of the action. If the request is not completed successfully, the domain registrant is notified by email.</li>\n<li>Charges your AWS account an amount based on the top-level domain. For more information, see <a href=\"http://aws.amazon.com/route53/pricing/\">Amazon Route 53 Pricing</a>.</li>\n</ul>\n<examples>\n<example>\n<name>RegisterDomain Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.RegisterDomain\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"DomainName\":\"example.com\",\n \"DurationInYears\":1,\n \"AutoRenew\":true,\n \"AdminContact\":{\n \"FirstName\":\"John\",\n \"MiddleName\":\"Richard\",\n \"LastName\":\"Doe\",\n \"ContactType\":\"PERSON\",\n \"OrganizationName\":\"\",\n \"AddressLine1\":\"123 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Any Town\",\n \"State\":\"WA\",\n \"CountryCode\":\"US\",\n \"ZipCode\":\"98101\",\n \"PhoneNumber\":\"+2065550100\",\n \"Email\":\"john@example.com\",\n \"Fax\":\"+2065550101\"\n },\n \"RegistrantContact\":{\n \"FirstName\":\"John\",\n \"MiddleName\":\"Richard\",\n \"LastName\":\"Doe\",\n \"ContactType\":\"PERSON\",\n \"OrganizationName\":\"\",\n \"AddressLine1\":\"123 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Any Town\",\n \"State\":\"WA\",\n \"CountryCode\":\"US\",\n \"ZipCode\":\"98101\",\n \"PhoneNumber\":\"+2065550100\",\n \"Email\":\"john@example.com\",\n \"Fax\":\"+2065550101\"\n },\n \"TechContact\":{\n \"FirstName\":\"John\",\n \"MiddleName\":\"Richard\",\n \"LastName\":\"Doe\",\n \"ContactType\":\"PERSON\",\n \"OrganizationName\":\"\",\n \"AddressLine1\":\"123 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Any Town\",\n \"State\":\"WA\",\n \"CountryCode\":\"US\",\n \"ZipCode\":\"98101\",\n \"PhoneNumber\":\"+2065550100\",\n \"Email\":\"john@example.com\",\n \"Fax\":\"+2065550101\"\n},\n\"PrivacyProtectAdminContact\":true,\n\"PrivacyProtectRegistrantContact\":true,\n\"PrivacyProtectTechContact\":true\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n \"OperationId\":\"308c56712-faa4-40fe-94c8-b423069de3f6\"\n}</response>\n</example>\n</examples>\n"
|
||||
},
|
||||
"RetrieveDomainAuthCode": {
|
||||
"name": "RetrieveDomainAuthCode",
|
||||
"input": {
|
||||
"shape_name": "RetrieveDomainAuthCodeRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"DomainName": {
|
||||
"shape_name": "DomainName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"pattern": "[a-zA-Z0-9_\\-.]*",
|
||||
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The RetrieveDomainAuthCode request includes the following element.</p>\n"
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "RetrieveDomainAuthCodeResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"AuthCode": {
|
||||
"shape_name": "DomainAuthCode",
|
||||
"type": "string",
|
||||
"max_length": 1024,
|
||||
"sensitive": true,
|
||||
"documentation": "\n<p>The authorization code for the domain.</p>\n<p>Type: String</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The RetrieveDomainAuthCode response includes the following element.</p>\n"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.</p>\n"
|
||||
}
|
||||
],
|
||||
"documentation": "\n<p>This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.</p>\n<examples>\n<example>\n<name>RetrieveDomainAuthCode Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.RetrieveDomainAuthCode\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"DomainName\":\"example.com\"\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n \"AuthCode\":\"rqL3*REjYH\"\n}</response>\n</example>\n</examples>\n"
|
||||
},
|
||||
"TransferDomain": {
|
||||
"name": "TransferDomain",
|
||||
"input": {
|
||||
"shape_name": "TransferDomainRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"DomainName": {
|
||||
"shape_name": "DomainName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"pattern": "[a-zA-Z0-9_\\-.]*",
|
||||
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"IdnLangCode": {
|
||||
"shape_name": "LangCode",
|
||||
"type": "string",
|
||||
"max_length": 3,
|
||||
"documentation": "\n<p>Reserved for future use.</p>\n"
|
||||
},
|
||||
"DurationInYears": {
|
||||
"shape_name": "DurationInYears",
|
||||
"type": "integer",
|
||||
"min_length": 1,
|
||||
"max_length": 10,
|
||||
"documentation": "\n<p>The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.</p>\n<p>Type: Integer</p>\n<p>Default: 1</p>\n<p>Valid values: Integer from 1 to 10</p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"Nameservers": {
|
||||
"shape_name": "NameserverList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Nameserver",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "HostName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"pattern": "[a-zA-Z0-9_\\-.]*",
|
||||
"documentation": "\n<p>The fully qualified host name of the name server.</p>\n<p>Type: String</p>\n<p>Constraint: Maximum 255 characterss</p>\n<p>Parent: <code>Nameservers</code></p>\n",
|
||||
"required": true
|
||||
},
|
||||
"GlueIps": {
|
||||
"shape_name": "GlueIpList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "GlueIp",
|
||||
"type": "string",
|
||||
"max_length": 45,
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "\n<p>Glue IP address of a name server entry. Glue IP addresses are required only when the name of the\nname server is a subdomain of the domain. For example, if your domain is example.com and the name\nserver for the domain is ns.example.com, you need to specify the IP address for ns.example.com.</p>\n<p>Type: List of IP addresses.</p>\n<p>Constraints: The list can contain only one IPv4 and one IPv6 address.</p>\n<p>Parent: <code>Nameservers</code></p>\n"
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>Nameserver includes the following elements.</p>\n"
|
||||
},
|
||||
"documentation": "\n<p>Contains details for the host and glue IP addresses.</p>\n<p>Type: Complex</p>\n<p>Children: <code>GlueIps</code>, <code>Name</code></p>\n",
|
||||
"required": true
|
||||
},
|
||||
"AuthCode": {
|
||||
"shape_name": "DomainAuthCode",
|
||||
"type": "string",
|
||||
"max_length": 1024,
|
||||
"sensitive": true,
|
||||
"documentation": "\n<p>The authorization code for the domain. You get this value from the current registrar.</p>\n<p>Type: String</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"AutoRenew": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n<p>Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.</p>\n<p>Type: Boolean</p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Default: true</p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"AdminContact": {
|
||||
"shape_name": "ContactDetail",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FirstName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"LastName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ContactType": {
|
||||
"shape_name": "ContactType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"PERSON",
|
||||
"COMPANY",
|
||||
"ASSOCIATION",
|
||||
"PUBLIC_BODY",
|
||||
"RESELLER"
|
||||
],
|
||||
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"OrganizationName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"AddressLine1": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"AddressLine2": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"City": {
|
||||
"shape_name": "City",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"State": {
|
||||
"shape_name": "State",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"CountryCode": {
|
||||
"shape_name": "CountryCode",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"AD",
|
||||
"AE",
|
||||
"AF",
|
||||
"AG",
|
||||
"AI",
|
||||
"AL",
|
||||
"AM",
|
||||
"AN",
|
||||
"AO",
|
||||
"AQ",
|
||||
"AR",
|
||||
"AS",
|
||||
"AT",
|
||||
"AU",
|
||||
"AW",
|
||||
"AZ",
|
||||
"BA",
|
||||
"BB",
|
||||
"BD",
|
||||
"BE",
|
||||
"BF",
|
||||
"BG",
|
||||
"BH",
|
||||
"BI",
|
||||
"BJ",
|
||||
"BL",
|
||||
"BM",
|
||||
"BN",
|
||||
"BO",
|
||||
"BR",
|
||||
"BS",
|
||||
"BT",
|
||||
"BW",
|
||||
"BY",
|
||||
"BZ",
|
||||
"CA",
|
||||
"CC",
|
||||
"CD",
|
||||
"CF",
|
||||
"CG",
|
||||
"CH",
|
||||
"CI",
|
||||
"CK",
|
||||
"CL",
|
||||
"CM",
|
||||
"CN",
|
||||
"CO",
|
||||
"CR",
|
||||
"CU",
|
||||
"CV",
|
||||
"CX",
|
||||
"CY",
|
||||
"CZ",
|
||||
"DE",
|
||||
"DJ",
|
||||
"DK",
|
||||
"DM",
|
||||
"DO",
|
||||
"DZ",
|
||||
"EC",
|
||||
"EE",
|
||||
"EG",
|
||||
"ER",
|
||||
"ES",
|
||||
"ET",
|
||||
"FI",
|
||||
"FJ",
|
||||
"FK",
|
||||
"FM",
|
||||
"FO",
|
||||
"FR",
|
||||
"GA",
|
||||
"GB",
|
||||
"GD",
|
||||
"GE",
|
||||
"GH",
|
||||
"GI",
|
||||
"GL",
|
||||
"GM",
|
||||
"GN",
|
||||
"GQ",
|
||||
"GR",
|
||||
"GT",
|
||||
"GU",
|
||||
"GW",
|
||||
"GY",
|
||||
"HK",
|
||||
"HN",
|
||||
"HR",
|
||||
"HT",
|
||||
"HU",
|
||||
"ID",
|
||||
"IE",
|
||||
"IL",
|
||||
"IM",
|
||||
"IN",
|
||||
"IQ",
|
||||
"IR",
|
||||
"IS",
|
||||
"IT",
|
||||
"JM",
|
||||
"JO",
|
||||
"JP",
|
||||
"KE",
|
||||
"KG",
|
||||
"KH",
|
||||
"KI",
|
||||
"KM",
|
||||
"KN",
|
||||
"KP",
|
||||
"KR",
|
||||
"KW",
|
||||
"KY",
|
||||
"KZ",
|
||||
"LA",
|
||||
"LB",
|
||||
"LC",
|
||||
"LI",
|
||||
"LK",
|
||||
"LR",
|
||||
"LS",
|
||||
"LT",
|
||||
"LU",
|
||||
"LV",
|
||||
"LY",
|
||||
"MA",
|
||||
"MC",
|
||||
"MD",
|
||||
"ME",
|
||||
"MF",
|
||||
"MG",
|
||||
"MH",
|
||||
"MK",
|
||||
"ML",
|
||||
"MM",
|
||||
"MN",
|
||||
"MO",
|
||||
"MP",
|
||||
"MR",
|
||||
"MS",
|
||||
"MT",
|
||||
"MU",
|
||||
"MV",
|
||||
"MW",
|
||||
"MX",
|
||||
"MY",
|
||||
"MZ",
|
||||
"NA",
|
||||
"NC",
|
||||
"NE",
|
||||
"NG",
|
||||
"NI",
|
||||
"NL",
|
||||
"NO",
|
||||
"NP",
|
||||
"NR",
|
||||
"NU",
|
||||
"NZ",
|
||||
"OM",
|
||||
"PA",
|
||||
"PE",
|
||||
"PF",
|
||||
"PG",
|
||||
"PH",
|
||||
"PK",
|
||||
"PL",
|
||||
"PM",
|
||||
"PN",
|
||||
"PR",
|
||||
"PT",
|
||||
"PW",
|
||||
"PY",
|
||||
"QA",
|
||||
"RO",
|
||||
"RS",
|
||||
"RU",
|
||||
"RW",
|
||||
"SA",
|
||||
"SB",
|
||||
"SC",
|
||||
"SD",
|
||||
"SE",
|
||||
"SG",
|
||||
"SH",
|
||||
"SI",
|
||||
"SK",
|
||||
"SL",
|
||||
"SM",
|
||||
"SN",
|
||||
"SO",
|
||||
"SR",
|
||||
"ST",
|
||||
"SV",
|
||||
"SY",
|
||||
"SZ",
|
||||
"TC",
|
||||
"TD",
|
||||
"TG",
|
||||
"TH",
|
||||
"TJ",
|
||||
"TK",
|
||||
"TL",
|
||||
"TM",
|
||||
"TN",
|
||||
"TO",
|
||||
"TR",
|
||||
"TT",
|
||||
"TV",
|
||||
"TW",
|
||||
"TZ",
|
||||
"UA",
|
||||
"UG",
|
||||
"US",
|
||||
"UY",
|
||||
"UZ",
|
||||
"VA",
|
||||
"VC",
|
||||
"VE",
|
||||
"VG",
|
||||
"VI",
|
||||
"VN",
|
||||
"VU",
|
||||
"WF",
|
||||
"WS",
|
||||
"YE",
|
||||
"YT",
|
||||
"ZA",
|
||||
"ZM",
|
||||
"ZW"
|
||||
],
|
||||
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ZipCode": {
|
||||
"shape_name": "ZipCode",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"PhoneNumber": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Email": {
|
||||
"shape_name": "Email",
|
||||
"type": "string",
|
||||
"max_length": 254,
|
||||
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Fax": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"ExtraParams": {
|
||||
"shape_name": "ExtraParamList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "ExtraParam",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "ExtraParamName",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DUNS_NUMBER",
|
||||
"BRAND_NUMBER",
|
||||
"BIRTH_DEPARTMENT",
|
||||
"BIRTH_DATE_IN_YYYY_MM_DD",
|
||||
"BIRTH_COUNTRY",
|
||||
"BIRTH_CITY",
|
||||
"DOCUMENT_NUMBER",
|
||||
"AU_ID_NUMBER",
|
||||
"AU_ID_TYPE",
|
||||
"CA_LEGAL_TYPE",
|
||||
"FI_BUSINESS_NUMBER",
|
||||
"FI_ID_NUMBER",
|
||||
"IT_PIN",
|
||||
"RU_PASSPORT_DATA",
|
||||
"SE_ID_NUMBER",
|
||||
"SG_ID_NUMBER",
|
||||
"VAT_NUMBER"
|
||||
],
|
||||
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "ExtraParamValue",
|
||||
"type": "string",
|
||||
"max_length": 2048,
|
||||
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
||||
},
|
||||
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
||||
}
|
||||
},
|
||||
"sensitive": true,
|
||||
"documentation": "\n<p>Provides detailed contact information.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>, <code>LastName</code>, <code>ContactType</code>, <code>OrganizationName</code>, <code>AddressLine1</code>, <code>AddressLine2</code>, <code>City</code>, <code>State</code>, <code>CountryCode</code>, <code>ZipCode</code>, <code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>, <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"RegistrantContact": {
|
||||
"shape_name": "ContactDetail",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FirstName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"LastName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ContactType": {
|
||||
"shape_name": "ContactType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"PERSON",
|
||||
"COMPANY",
|
||||
"ASSOCIATION",
|
||||
"PUBLIC_BODY",
|
||||
"RESELLER"
|
||||
],
|
||||
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"OrganizationName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"AddressLine1": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"AddressLine2": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"City": {
|
||||
"shape_name": "City",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"State": {
|
||||
"shape_name": "State",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"CountryCode": {
|
||||
"shape_name": "CountryCode",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"AD",
|
||||
"AE",
|
||||
"AF",
|
||||
"AG",
|
||||
"AI",
|
||||
"AL",
|
||||
"AM",
|
||||
"AN",
|
||||
"AO",
|
||||
"AQ",
|
||||
"AR",
|
||||
"AS",
|
||||
"AT",
|
||||
"AU",
|
||||
"AW",
|
||||
"AZ",
|
||||
"BA",
|
||||
"BB",
|
||||
"BD",
|
||||
"BE",
|
||||
"BF",
|
||||
"BG",
|
||||
"BH",
|
||||
"BI",
|
||||
"BJ",
|
||||
"BL",
|
||||
"BM",
|
||||
"BN",
|
||||
"BO",
|
||||
"BR",
|
||||
"BS",
|
||||
"BT",
|
||||
"BW",
|
||||
"BY",
|
||||
"BZ",
|
||||
"CA",
|
||||
"CC",
|
||||
"CD",
|
||||
"CF",
|
||||
"CG",
|
||||
"CH",
|
||||
"CI",
|
||||
"CK",
|
||||
"CL",
|
||||
"CM",
|
||||
"CN",
|
||||
"CO",
|
||||
"CR",
|
||||
"CU",
|
||||
"CV",
|
||||
"CX",
|
||||
"CY",
|
||||
"CZ",
|
||||
"DE",
|
||||
"DJ",
|
||||
"DK",
|
||||
"DM",
|
||||
"DO",
|
||||
"DZ",
|
||||
"EC",
|
||||
"EE",
|
||||
"EG",
|
||||
"ER",
|
||||
"ES",
|
||||
"ET",
|
||||
"FI",
|
||||
"FJ",
|
||||
"FK",
|
||||
"FM",
|
||||
"FO",
|
||||
"FR",
|
||||
"GA",
|
||||
"GB",
|
||||
"GD",
|
||||
"GE",
|
||||
"GH",
|
||||
"GI",
|
||||
"GL",
|
||||
"GM",
|
||||
"GN",
|
||||
"GQ",
|
||||
"GR",
|
||||
"GT",
|
||||
"GU",
|
||||
"GW",
|
||||
"GY",
|
||||
"HK",
|
||||
"HN",
|
||||
"HR",
|
||||
"HT",
|
||||
"HU",
|
||||
"ID",
|
||||
"IE",
|
||||
"IL",
|
||||
"IM",
|
||||
"IN",
|
||||
"IQ",
|
||||
"IR",
|
||||
"IS",
|
||||
"IT",
|
||||
"JM",
|
||||
"JO",
|
||||
"JP",
|
||||
"KE",
|
||||
"KG",
|
||||
"KH",
|
||||
"KI",
|
||||
"KM",
|
||||
"KN",
|
||||
"KP",
|
||||
"KR",
|
||||
"KW",
|
||||
"KY",
|
||||
"KZ",
|
||||
"LA",
|
||||
"LB",
|
||||
"LC",
|
||||
"LI",
|
||||
"LK",
|
||||
"LR",
|
||||
"LS",
|
||||
"LT",
|
||||
"LU",
|
||||
"LV",
|
||||
"LY",
|
||||
"MA",
|
||||
"MC",
|
||||
"MD",
|
||||
"ME",
|
||||
"MF",
|
||||
"MG",
|
||||
"MH",
|
||||
"MK",
|
||||
"ML",
|
||||
"MM",
|
||||
"MN",
|
||||
"MO",
|
||||
"MP",
|
||||
"MR",
|
||||
"MS",
|
||||
"MT",
|
||||
"MU",
|
||||
"MV",
|
||||
"MW",
|
||||
"MX",
|
||||
"MY",
|
||||
"MZ",
|
||||
"NA",
|
||||
"NC",
|
||||
"NE",
|
||||
"NG",
|
||||
"NI",
|
||||
"NL",
|
||||
"NO",
|
||||
"NP",
|
||||
"NR",
|
||||
"NU",
|
||||
"NZ",
|
||||
"OM",
|
||||
"PA",
|
||||
"PE",
|
||||
"PF",
|
||||
"PG",
|
||||
"PH",
|
||||
"PK",
|
||||
"PL",
|
||||
"PM",
|
||||
"PN",
|
||||
"PR",
|
||||
"PT",
|
||||
"PW",
|
||||
"PY",
|
||||
"QA",
|
||||
"RO",
|
||||
"RS",
|
||||
"RU",
|
||||
"RW",
|
||||
"SA",
|
||||
"SB",
|
||||
"SC",
|
||||
"SD",
|
||||
"SE",
|
||||
"SG",
|
||||
"SH",
|
||||
"SI",
|
||||
"SK",
|
||||
"SL",
|
||||
"SM",
|
||||
"SN",
|
||||
"SO",
|
||||
"SR",
|
||||
"ST",
|
||||
"SV",
|
||||
"SY",
|
||||
"SZ",
|
||||
"TC",
|
||||
"TD",
|
||||
"TG",
|
||||
"TH",
|
||||
"TJ",
|
||||
"TK",
|
||||
"TL",
|
||||
"TM",
|
||||
"TN",
|
||||
"TO",
|
||||
"TR",
|
||||
"TT",
|
||||
"TV",
|
||||
"TW",
|
||||
"TZ",
|
||||
"UA",
|
||||
"UG",
|
||||
"US",
|
||||
"UY",
|
||||
"UZ",
|
||||
"VA",
|
||||
"VC",
|
||||
"VE",
|
||||
"VG",
|
||||
"VI",
|
||||
"VN",
|
||||
"VU",
|
||||
"WF",
|
||||
"WS",
|
||||
"YE",
|
||||
"YT",
|
||||
"ZA",
|
||||
"ZM",
|
||||
"ZW"
|
||||
],
|
||||
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ZipCode": {
|
||||
"shape_name": "ZipCode",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"PhoneNumber": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Email": {
|
||||
"shape_name": "Email",
|
||||
"type": "string",
|
||||
"max_length": 254,
|
||||
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Fax": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"ExtraParams": {
|
||||
"shape_name": "ExtraParamList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "ExtraParam",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "ExtraParamName",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DUNS_NUMBER",
|
||||
"BRAND_NUMBER",
|
||||
"BIRTH_DEPARTMENT",
|
||||
"BIRTH_DATE_IN_YYYY_MM_DD",
|
||||
"BIRTH_COUNTRY",
|
||||
"BIRTH_CITY",
|
||||
"DOCUMENT_NUMBER",
|
||||
"AU_ID_NUMBER",
|
||||
"AU_ID_TYPE",
|
||||
"CA_LEGAL_TYPE",
|
||||
"FI_BUSINESS_NUMBER",
|
||||
"FI_ID_NUMBER",
|
||||
"IT_PIN",
|
||||
"RU_PASSPORT_DATA",
|
||||
"SE_ID_NUMBER",
|
||||
"SG_ID_NUMBER",
|
||||
"VAT_NUMBER"
|
||||
],
|
||||
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "ExtraParamValue",
|
||||
"type": "string",
|
||||
"max_length": 2048,
|
||||
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
||||
},
|
||||
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
||||
}
|
||||
},
|
||||
"sensitive": true,
|
||||
"documentation": "\n<p>Provides detailed contact information.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>, <code>LastName</code>, <code>ContactType</code>, <code>OrganizationName</code>, <code>AddressLine1</code>, <code>AddressLine2</code>, <code>City</code>, <code>State</code>, <code>CountryCode</code>, <code>ZipCode</code>, <code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>, <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"TechContact": {
|
||||
"shape_name": "ContactDetail",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FirstName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"LastName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ContactType": {
|
||||
"shape_name": "ContactType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"PERSON",
|
||||
"COMPANY",
|
||||
"ASSOCIATION",
|
||||
"PUBLIC_BODY",
|
||||
"RESELLER"
|
||||
],
|
||||
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"OrganizationName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"AddressLine1": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"AddressLine2": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"City": {
|
||||
"shape_name": "City",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"State": {
|
||||
"shape_name": "State",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"CountryCode": {
|
||||
"shape_name": "CountryCode",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"AD",
|
||||
"AE",
|
||||
"AF",
|
||||
"AG",
|
||||
"AI",
|
||||
"AL",
|
||||
"AM",
|
||||
"AN",
|
||||
"AO",
|
||||
"AQ",
|
||||
"AR",
|
||||
"AS",
|
||||
"AT",
|
||||
"AU",
|
||||
"AW",
|
||||
"AZ",
|
||||
"BA",
|
||||
"BB",
|
||||
"BD",
|
||||
"BE",
|
||||
"BF",
|
||||
"BG",
|
||||
"BH",
|
||||
"BI",
|
||||
"BJ",
|
||||
"BL",
|
||||
"BM",
|
||||
"BN",
|
||||
"BO",
|
||||
"BR",
|
||||
"BS",
|
||||
"BT",
|
||||
"BW",
|
||||
"BY",
|
||||
"BZ",
|
||||
"CA",
|
||||
"CC",
|
||||
"CD",
|
||||
"CF",
|
||||
"CG",
|
||||
"CH",
|
||||
"CI",
|
||||
"CK",
|
||||
"CL",
|
||||
"CM",
|
||||
"CN",
|
||||
"CO",
|
||||
"CR",
|
||||
"CU",
|
||||
"CV",
|
||||
"CX",
|
||||
"CY",
|
||||
"CZ",
|
||||
"DE",
|
||||
"DJ",
|
||||
"DK",
|
||||
"DM",
|
||||
"DO",
|
||||
"DZ",
|
||||
"EC",
|
||||
"EE",
|
||||
"EG",
|
||||
"ER",
|
||||
"ES",
|
||||
"ET",
|
||||
"FI",
|
||||
"FJ",
|
||||
"FK",
|
||||
"FM",
|
||||
"FO",
|
||||
"FR",
|
||||
"GA",
|
||||
"GB",
|
||||
"GD",
|
||||
"GE",
|
||||
"GH",
|
||||
"GI",
|
||||
"GL",
|
||||
"GM",
|
||||
"GN",
|
||||
"GQ",
|
||||
"GR",
|
||||
"GT",
|
||||
"GU",
|
||||
"GW",
|
||||
"GY",
|
||||
"HK",
|
||||
"HN",
|
||||
"HR",
|
||||
"HT",
|
||||
"HU",
|
||||
"ID",
|
||||
"IE",
|
||||
"IL",
|
||||
"IM",
|
||||
"IN",
|
||||
"IQ",
|
||||
"IR",
|
||||
"IS",
|
||||
"IT",
|
||||
"JM",
|
||||
"JO",
|
||||
"JP",
|
||||
"KE",
|
||||
"KG",
|
||||
"KH",
|
||||
"KI",
|
||||
"KM",
|
||||
"KN",
|
||||
"KP",
|
||||
"KR",
|
||||
"KW",
|
||||
"KY",
|
||||
"KZ",
|
||||
"LA",
|
||||
"LB",
|
||||
"LC",
|
||||
"LI",
|
||||
"LK",
|
||||
"LR",
|
||||
"LS",
|
||||
"LT",
|
||||
"LU",
|
||||
"LV",
|
||||
"LY",
|
||||
"MA",
|
||||
"MC",
|
||||
"MD",
|
||||
"ME",
|
||||
"MF",
|
||||
"MG",
|
||||
"MH",
|
||||
"MK",
|
||||
"ML",
|
||||
"MM",
|
||||
"MN",
|
||||
"MO",
|
||||
"MP",
|
||||
"MR",
|
||||
"MS",
|
||||
"MT",
|
||||
"MU",
|
||||
"MV",
|
||||
"MW",
|
||||
"MX",
|
||||
"MY",
|
||||
"MZ",
|
||||
"NA",
|
||||
"NC",
|
||||
"NE",
|
||||
"NG",
|
||||
"NI",
|
||||
"NL",
|
||||
"NO",
|
||||
"NP",
|
||||
"NR",
|
||||
"NU",
|
||||
"NZ",
|
||||
"OM",
|
||||
"PA",
|
||||
"PE",
|
||||
"PF",
|
||||
"PG",
|
||||
"PH",
|
||||
"PK",
|
||||
"PL",
|
||||
"PM",
|
||||
"PN",
|
||||
"PR",
|
||||
"PT",
|
||||
"PW",
|
||||
"PY",
|
||||
"QA",
|
||||
"RO",
|
||||
"RS",
|
||||
"RU",
|
||||
"RW",
|
||||
"SA",
|
||||
"SB",
|
||||
"SC",
|
||||
"SD",
|
||||
"SE",
|
||||
"SG",
|
||||
"SH",
|
||||
"SI",
|
||||
"SK",
|
||||
"SL",
|
||||
"SM",
|
||||
"SN",
|
||||
"SO",
|
||||
"SR",
|
||||
"ST",
|
||||
"SV",
|
||||
"SY",
|
||||
"SZ",
|
||||
"TC",
|
||||
"TD",
|
||||
"TG",
|
||||
"TH",
|
||||
"TJ",
|
||||
"TK",
|
||||
"TL",
|
||||
"TM",
|
||||
"TN",
|
||||
"TO",
|
||||
"TR",
|
||||
"TT",
|
||||
"TV",
|
||||
"TW",
|
||||
"TZ",
|
||||
"UA",
|
||||
"UG",
|
||||
"US",
|
||||
"UY",
|
||||
"UZ",
|
||||
"VA",
|
||||
"VC",
|
||||
"VE",
|
||||
"VG",
|
||||
"VI",
|
||||
"VN",
|
||||
"VU",
|
||||
"WF",
|
||||
"WS",
|
||||
"YE",
|
||||
"YT",
|
||||
"ZA",
|
||||
"ZM",
|
||||
"ZW"
|
||||
],
|
||||
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ZipCode": {
|
||||
"shape_name": "ZipCode",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"PhoneNumber": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Email": {
|
||||
"shape_name": "Email",
|
||||
"type": "string",
|
||||
"max_length": 254,
|
||||
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Fax": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"ExtraParams": {
|
||||
"shape_name": "ExtraParamList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "ExtraParam",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "ExtraParamName",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DUNS_NUMBER",
|
||||
"BRAND_NUMBER",
|
||||
"BIRTH_DEPARTMENT",
|
||||
"BIRTH_DATE_IN_YYYY_MM_DD",
|
||||
"BIRTH_COUNTRY",
|
||||
"BIRTH_CITY",
|
||||
"DOCUMENT_NUMBER",
|
||||
"AU_ID_NUMBER",
|
||||
"AU_ID_TYPE",
|
||||
"CA_LEGAL_TYPE",
|
||||
"FI_BUSINESS_NUMBER",
|
||||
"FI_ID_NUMBER",
|
||||
"IT_PIN",
|
||||
"RU_PASSPORT_DATA",
|
||||
"SE_ID_NUMBER",
|
||||
"SG_ID_NUMBER",
|
||||
"VAT_NUMBER"
|
||||
],
|
||||
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "ExtraParamValue",
|
||||
"type": "string",
|
||||
"max_length": 2048,
|
||||
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
||||
},
|
||||
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
||||
}
|
||||
},
|
||||
"sensitive": true,
|
||||
"documentation": "\n<p>Provides detailed contact information.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>, <code>LastName</code>, <code>ContactType</code>, <code>OrganizationName</code>, <code>AddressLine1</code>, <code>AddressLine2</code>, <code>City</code>, <code>State</code>, <code>CountryCode</code>, <code>ZipCode</code>, <code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>, <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"PrivacyProtectAdminContact": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n<p>Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.</p>\n<p>Type: Boolean</p>\n<p>Default: <code>true</code></p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Required: No</p>\n\n"
|
||||
},
|
||||
"PrivacyProtectRegistrantContact": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n<p>Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.</p>\n<p>Type: Boolean</p>\n<p>Default: <code>true</code></p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Required: No</p>\n\n"
|
||||
},
|
||||
"PrivacyProtectTechContact": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n<p>Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.</p>\n<p>Type: Boolean</p>\n<p>Default: <code>true</code></p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Required: No</p>\n\n"
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The TransferDomain request includes the following elements.</p>\n"
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "TransferDomainResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"OperationId": {
|
||||
"shape_name": "OperationId",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.</p>\n <p>Type: String</p>\n <p>Default: None</p>\n <p>Constraints: Maximum 255 characters.</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The TranserDomain response includes the following element.</p>\n"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "UnsupportedTLD",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Amazon Route 53 does not support this top-level domain.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "DuplicateRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The request is already in progress for the domain.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "TLDRulesViolation",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The top-level domain does not support this operation.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "DomainLimitExceeded",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The number of domains has exceeded the allowed threshold for the account.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "OperationLimitExceeded",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The number of operations or jobs running exceeded the allowed threshold for the account.</p>\n"
|
||||
}
|
||||
],
|
||||
"documentation": "\n<p>This operation transfers a domain from another registrar to Amazon Route 53. Domains are registered by the\nAWS registrar, Gandi upon transfer.</p>\n<p>To transfer a domain, you need to meet all the domain transfer criteria, including the following:</p>\n<ul>\n<li>You must supply nameservers to transfer a domain.</li>\n<li>You must disable the domain transfer lock (if any) before transferring the domain.</li>\n<li>A minimum of 60 days must have elapsed since the domain's registration or last transfer.</li>\n</ul>\n<p>We recommend you use the Amazon Route 53 as the DNS service for your domain. You can create a hosted\nzone in Amazon Route 53 for your current domain before transferring your domain.</p>\n<p>Note that upon transfer, the domain duration is extended for a year if not otherwise\nspecified. Autorenew is enabled by default.</p>\n<p>If the transfer is successful, this method returns an operation ID that you can use to\ntrack the progress and completion of the action. If the request is not completed\nsuccessfully, the domain registrant will be notified by email.</p>\n<p>Transferring domains charges your AWS account an amount based on the top-level domain. For more\ninformation, see <a href=\"http://aws.amazon.com/route53/pricing/\">Amazon Route 53 Pricing</a>. </p>\n<examples>\n<example>\n<name>TransferDomain Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.TransferDomain\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"DomainName\":\"example.com\",\n \"DurationInYears\":1,\n \"Nameservers\":[\n {\n \"Name\":\"ns-2048.awsdns-64.com\",\n \"GlueIps\":[\n \"192.0.2.11\"\n ]\n },\n {\n \"Name\":\"ns-2049.awsdns-65.net\",\n \"GlueIps\":[\n \"192.0.2.12\"\n ]\n }\n ],\n \"AuthCode\":\"a42qxjz1\",\n \"AutoRenew\":true,\n \"AdminContact\":{\n \"FirstName\":\"John\",\n \"MiddleName\":\"Richard\",\n \"LastName\":\"Doe\",\n \"ContactType\":\"PERSON\",\n \"OrganizationName\":\"\",\n \"AddressLine1\":\"123 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Any Town\",\n \"State\":\"WA\",\n \"CountryCode\":\"US\",\n \"ZipCode\":\"98101\",\n \"PhoneNumber\":\"+2065550100\",\n \"Email\":\"john@example.com\",\n \"Fax\":\"+206555-0101\"\n },\n \"RegistrantContact\":{\n \"FirstName\":\"John\",\n \"MiddleName\":\"Richard\",\n \"LastName\":\"Doe\",\n \"ContactType\":\"PERSON\",\n \"OrganizationName\":\"\",\n \"AddressLine1\":\"123 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Any Town\",\n \"State\":\"WA\",\n \"CountryCode\":\"US\",\n \"ZipCode\":\"98101\",\n \"PhoneNumber\":\"+2065550100\",\n \"Email\":\"john@example.com\",\n \"Fax\":\"+206555-0101\"\n },\n \"TechContact\":{\n \"FirstName\":\"John\",\n \"MiddleName\":\"Richard\",\n \"LastName\":\"Doe\",\n \"ContactType\":\"PERSON\",\n \"OrganizationName\":\"\",\n \"AddressLine1\":\"123 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Any Town\",\n \"State\":\"WA\",\n \"CountryCode\":\"US\",\n \"ZipCode\":\"98101\",\n \"PhoneNumber\":\"+2065550100\",\n \"Email\":\"john@example.com\",\n \"Fax\":\"+206555-0101\"\n },\n \"PrivacyProtectAdminContact\":true,\n \"PrivacyProtectRegistrantContact\":true,\n \"PrivacyProtectTechContact\":true,\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n\"OperationId\":\"308c56712-faa4-40fe-94c8-b423069de3f6\"\n}</response>\n</example>\n</examples>\n"
|
||||
},
|
||||
"UpdateDomainContact": {
|
||||
"name": "UpdateDomainContact",
|
||||
"input": {
|
||||
"shape_name": "UpdateDomainContactRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"DomainName": {
|
||||
"shape_name": "DomainName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"pattern": "[a-zA-Z0-9_\\-.]*",
|
||||
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"AdminContact": {
|
||||
"shape_name": "ContactDetail",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FirstName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"LastName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ContactType": {
|
||||
"shape_name": "ContactType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"PERSON",
|
||||
"COMPANY",
|
||||
"ASSOCIATION",
|
||||
"PUBLIC_BODY",
|
||||
"RESELLER"
|
||||
],
|
||||
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"OrganizationName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"AddressLine1": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"AddressLine2": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"City": {
|
||||
"shape_name": "City",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"State": {
|
||||
"shape_name": "State",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"CountryCode": {
|
||||
"shape_name": "CountryCode",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"AD",
|
||||
"AE",
|
||||
"AF",
|
||||
"AG",
|
||||
"AI",
|
||||
"AL",
|
||||
"AM",
|
||||
"AN",
|
||||
"AO",
|
||||
"AQ",
|
||||
"AR",
|
||||
"AS",
|
||||
"AT",
|
||||
"AU",
|
||||
"AW",
|
||||
"AZ",
|
||||
"BA",
|
||||
"BB",
|
||||
"BD",
|
||||
"BE",
|
||||
"BF",
|
||||
"BG",
|
||||
"BH",
|
||||
"BI",
|
||||
"BJ",
|
||||
"BL",
|
||||
"BM",
|
||||
"BN",
|
||||
"BO",
|
||||
"BR",
|
||||
"BS",
|
||||
"BT",
|
||||
"BW",
|
||||
"BY",
|
||||
"BZ",
|
||||
"CA",
|
||||
"CC",
|
||||
"CD",
|
||||
"CF",
|
||||
"CG",
|
||||
"CH",
|
||||
"CI",
|
||||
"CK",
|
||||
"CL",
|
||||
"CM",
|
||||
"CN",
|
||||
"CO",
|
||||
"CR",
|
||||
"CU",
|
||||
"CV",
|
||||
"CX",
|
||||
"CY",
|
||||
"CZ",
|
||||
"DE",
|
||||
"DJ",
|
||||
"DK",
|
||||
"DM",
|
||||
"DO",
|
||||
"DZ",
|
||||
"EC",
|
||||
"EE",
|
||||
"EG",
|
||||
"ER",
|
||||
"ES",
|
||||
"ET",
|
||||
"FI",
|
||||
"FJ",
|
||||
"FK",
|
||||
"FM",
|
||||
"FO",
|
||||
"FR",
|
||||
"GA",
|
||||
"GB",
|
||||
"GD",
|
||||
"GE",
|
||||
"GH",
|
||||
"GI",
|
||||
"GL",
|
||||
"GM",
|
||||
"GN",
|
||||
"GQ",
|
||||
"GR",
|
||||
"GT",
|
||||
"GU",
|
||||
"GW",
|
||||
"GY",
|
||||
"HK",
|
||||
"HN",
|
||||
"HR",
|
||||
"HT",
|
||||
"HU",
|
||||
"ID",
|
||||
"IE",
|
||||
"IL",
|
||||
"IM",
|
||||
"IN",
|
||||
"IQ",
|
||||
"IR",
|
||||
"IS",
|
||||
"IT",
|
||||
"JM",
|
||||
"JO",
|
||||
"JP",
|
||||
"KE",
|
||||
"KG",
|
||||
"KH",
|
||||
"KI",
|
||||
"KM",
|
||||
"KN",
|
||||
"KP",
|
||||
"KR",
|
||||
"KW",
|
||||
"KY",
|
||||
"KZ",
|
||||
"LA",
|
||||
"LB",
|
||||
"LC",
|
||||
"LI",
|
||||
"LK",
|
||||
"LR",
|
||||
"LS",
|
||||
"LT",
|
||||
"LU",
|
||||
"LV",
|
||||
"LY",
|
||||
"MA",
|
||||
"MC",
|
||||
"MD",
|
||||
"ME",
|
||||
"MF",
|
||||
"MG",
|
||||
"MH",
|
||||
"MK",
|
||||
"ML",
|
||||
"MM",
|
||||
"MN",
|
||||
"MO",
|
||||
"MP",
|
||||
"MR",
|
||||
"MS",
|
||||
"MT",
|
||||
"MU",
|
||||
"MV",
|
||||
"MW",
|
||||
"MX",
|
||||
"MY",
|
||||
"MZ",
|
||||
"NA",
|
||||
"NC",
|
||||
"NE",
|
||||
"NG",
|
||||
"NI",
|
||||
"NL",
|
||||
"NO",
|
||||
"NP",
|
||||
"NR",
|
||||
"NU",
|
||||
"NZ",
|
||||
"OM",
|
||||
"PA",
|
||||
"PE",
|
||||
"PF",
|
||||
"PG",
|
||||
"PH",
|
||||
"PK",
|
||||
"PL",
|
||||
"PM",
|
||||
"PN",
|
||||
"PR",
|
||||
"PT",
|
||||
"PW",
|
||||
"PY",
|
||||
"QA",
|
||||
"RO",
|
||||
"RS",
|
||||
"RU",
|
||||
"RW",
|
||||
"SA",
|
||||
"SB",
|
||||
"SC",
|
||||
"SD",
|
||||
"SE",
|
||||
"SG",
|
||||
"SH",
|
||||
"SI",
|
||||
"SK",
|
||||
"SL",
|
||||
"SM",
|
||||
"SN",
|
||||
"SO",
|
||||
"SR",
|
||||
"ST",
|
||||
"SV",
|
||||
"SY",
|
||||
"SZ",
|
||||
"TC",
|
||||
"TD",
|
||||
"TG",
|
||||
"TH",
|
||||
"TJ",
|
||||
"TK",
|
||||
"TL",
|
||||
"TM",
|
||||
"TN",
|
||||
"TO",
|
||||
"TR",
|
||||
"TT",
|
||||
"TV",
|
||||
"TW",
|
||||
"TZ",
|
||||
"UA",
|
||||
"UG",
|
||||
"US",
|
||||
"UY",
|
||||
"UZ",
|
||||
"VA",
|
||||
"VC",
|
||||
"VE",
|
||||
"VG",
|
||||
"VI",
|
||||
"VN",
|
||||
"VU",
|
||||
"WF",
|
||||
"WS",
|
||||
"YE",
|
||||
"YT",
|
||||
"ZA",
|
||||
"ZM",
|
||||
"ZW"
|
||||
],
|
||||
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ZipCode": {
|
||||
"shape_name": "ZipCode",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"PhoneNumber": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Email": {
|
||||
"shape_name": "Email",
|
||||
"type": "string",
|
||||
"max_length": 254,
|
||||
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Fax": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"ExtraParams": {
|
||||
"shape_name": "ExtraParamList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "ExtraParam",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "ExtraParamName",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DUNS_NUMBER",
|
||||
"BRAND_NUMBER",
|
||||
"BIRTH_DEPARTMENT",
|
||||
"BIRTH_DATE_IN_YYYY_MM_DD",
|
||||
"BIRTH_COUNTRY",
|
||||
"BIRTH_CITY",
|
||||
"DOCUMENT_NUMBER",
|
||||
"AU_ID_NUMBER",
|
||||
"AU_ID_TYPE",
|
||||
"CA_LEGAL_TYPE",
|
||||
"FI_BUSINESS_NUMBER",
|
||||
"FI_ID_NUMBER",
|
||||
"IT_PIN",
|
||||
"RU_PASSPORT_DATA",
|
||||
"SE_ID_NUMBER",
|
||||
"SG_ID_NUMBER",
|
||||
"VAT_NUMBER"
|
||||
],
|
||||
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "ExtraParamValue",
|
||||
"type": "string",
|
||||
"max_length": 2048,
|
||||
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
||||
},
|
||||
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
||||
}
|
||||
},
|
||||
"sensitive": true,
|
||||
"documentation": "\n<p>Provides detailed contact information.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>, <code>LastName</code>, <code>ContactType</code>, <code>OrganizationName</code>, <code>AddressLine1</code>, <code>AddressLine2</code>, <code>City</code>, <code>State</code>, <code>CountryCode</code>, <code>ZipCode</code>, <code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>, <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"RegistrantContact": {
|
||||
"shape_name": "ContactDetail",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FirstName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"LastName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ContactType": {
|
||||
"shape_name": "ContactType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"PERSON",
|
||||
"COMPANY",
|
||||
"ASSOCIATION",
|
||||
"PUBLIC_BODY",
|
||||
"RESELLER"
|
||||
],
|
||||
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"OrganizationName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"AddressLine1": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"AddressLine2": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"City": {
|
||||
"shape_name": "City",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"State": {
|
||||
"shape_name": "State",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"CountryCode": {
|
||||
"shape_name": "CountryCode",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"AD",
|
||||
"AE",
|
||||
"AF",
|
||||
"AG",
|
||||
"AI",
|
||||
"AL",
|
||||
"AM",
|
||||
"AN",
|
||||
"AO",
|
||||
"AQ",
|
||||
"AR",
|
||||
"AS",
|
||||
"AT",
|
||||
"AU",
|
||||
"AW",
|
||||
"AZ",
|
||||
"BA",
|
||||
"BB",
|
||||
"BD",
|
||||
"BE",
|
||||
"BF",
|
||||
"BG",
|
||||
"BH",
|
||||
"BI",
|
||||
"BJ",
|
||||
"BL",
|
||||
"BM",
|
||||
"BN",
|
||||
"BO",
|
||||
"BR",
|
||||
"BS",
|
||||
"BT",
|
||||
"BW",
|
||||
"BY",
|
||||
"BZ",
|
||||
"CA",
|
||||
"CC",
|
||||
"CD",
|
||||
"CF",
|
||||
"CG",
|
||||
"CH",
|
||||
"CI",
|
||||
"CK",
|
||||
"CL",
|
||||
"CM",
|
||||
"CN",
|
||||
"CO",
|
||||
"CR",
|
||||
"CU",
|
||||
"CV",
|
||||
"CX",
|
||||
"CY",
|
||||
"CZ",
|
||||
"DE",
|
||||
"DJ",
|
||||
"DK",
|
||||
"DM",
|
||||
"DO",
|
||||
"DZ",
|
||||
"EC",
|
||||
"EE",
|
||||
"EG",
|
||||
"ER",
|
||||
"ES",
|
||||
"ET",
|
||||
"FI",
|
||||
"FJ",
|
||||
"FK",
|
||||
"FM",
|
||||
"FO",
|
||||
"FR",
|
||||
"GA",
|
||||
"GB",
|
||||
"GD",
|
||||
"GE",
|
||||
"GH",
|
||||
"GI",
|
||||
"GL",
|
||||
"GM",
|
||||
"GN",
|
||||
"GQ",
|
||||
"GR",
|
||||
"GT",
|
||||
"GU",
|
||||
"GW",
|
||||
"GY",
|
||||
"HK",
|
||||
"HN",
|
||||
"HR",
|
||||
"HT",
|
||||
"HU",
|
||||
"ID",
|
||||
"IE",
|
||||
"IL",
|
||||
"IM",
|
||||
"IN",
|
||||
"IQ",
|
||||
"IR",
|
||||
"IS",
|
||||
"IT",
|
||||
"JM",
|
||||
"JO",
|
||||
"JP",
|
||||
"KE",
|
||||
"KG",
|
||||
"KH",
|
||||
"KI",
|
||||
"KM",
|
||||
"KN",
|
||||
"KP",
|
||||
"KR",
|
||||
"KW",
|
||||
"KY",
|
||||
"KZ",
|
||||
"LA",
|
||||
"LB",
|
||||
"LC",
|
||||
"LI",
|
||||
"LK",
|
||||
"LR",
|
||||
"LS",
|
||||
"LT",
|
||||
"LU",
|
||||
"LV",
|
||||
"LY",
|
||||
"MA",
|
||||
"MC",
|
||||
"MD",
|
||||
"ME",
|
||||
"MF",
|
||||
"MG",
|
||||
"MH",
|
||||
"MK",
|
||||
"ML",
|
||||
"MM",
|
||||
"MN",
|
||||
"MO",
|
||||
"MP",
|
||||
"MR",
|
||||
"MS",
|
||||
"MT",
|
||||
"MU",
|
||||
"MV",
|
||||
"MW",
|
||||
"MX",
|
||||
"MY",
|
||||
"MZ",
|
||||
"NA",
|
||||
"NC",
|
||||
"NE",
|
||||
"NG",
|
||||
"NI",
|
||||
"NL",
|
||||
"NO",
|
||||
"NP",
|
||||
"NR",
|
||||
"NU",
|
||||
"NZ",
|
||||
"OM",
|
||||
"PA",
|
||||
"PE",
|
||||
"PF",
|
||||
"PG",
|
||||
"PH",
|
||||
"PK",
|
||||
"PL",
|
||||
"PM",
|
||||
"PN",
|
||||
"PR",
|
||||
"PT",
|
||||
"PW",
|
||||
"PY",
|
||||
"QA",
|
||||
"RO",
|
||||
"RS",
|
||||
"RU",
|
||||
"RW",
|
||||
"SA",
|
||||
"SB",
|
||||
"SC",
|
||||
"SD",
|
||||
"SE",
|
||||
"SG",
|
||||
"SH",
|
||||
"SI",
|
||||
"SK",
|
||||
"SL",
|
||||
"SM",
|
||||
"SN",
|
||||
"SO",
|
||||
"SR",
|
||||
"ST",
|
||||
"SV",
|
||||
"SY",
|
||||
"SZ",
|
||||
"TC",
|
||||
"TD",
|
||||
"TG",
|
||||
"TH",
|
||||
"TJ",
|
||||
"TK",
|
||||
"TL",
|
||||
"TM",
|
||||
"TN",
|
||||
"TO",
|
||||
"TR",
|
||||
"TT",
|
||||
"TV",
|
||||
"TW",
|
||||
"TZ",
|
||||
"UA",
|
||||
"UG",
|
||||
"US",
|
||||
"UY",
|
||||
"UZ",
|
||||
"VA",
|
||||
"VC",
|
||||
"VE",
|
||||
"VG",
|
||||
"VI",
|
||||
"VN",
|
||||
"VU",
|
||||
"WF",
|
||||
"WS",
|
||||
"YE",
|
||||
"YT",
|
||||
"ZA",
|
||||
"ZM",
|
||||
"ZW"
|
||||
],
|
||||
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ZipCode": {
|
||||
"shape_name": "ZipCode",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"PhoneNumber": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Email": {
|
||||
"shape_name": "Email",
|
||||
"type": "string",
|
||||
"max_length": 254,
|
||||
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Fax": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"ExtraParams": {
|
||||
"shape_name": "ExtraParamList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "ExtraParam",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "ExtraParamName",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DUNS_NUMBER",
|
||||
"BRAND_NUMBER",
|
||||
"BIRTH_DEPARTMENT",
|
||||
"BIRTH_DATE_IN_YYYY_MM_DD",
|
||||
"BIRTH_COUNTRY",
|
||||
"BIRTH_CITY",
|
||||
"DOCUMENT_NUMBER",
|
||||
"AU_ID_NUMBER",
|
||||
"AU_ID_TYPE",
|
||||
"CA_LEGAL_TYPE",
|
||||
"FI_BUSINESS_NUMBER",
|
||||
"FI_ID_NUMBER",
|
||||
"IT_PIN",
|
||||
"RU_PASSPORT_DATA",
|
||||
"SE_ID_NUMBER",
|
||||
"SG_ID_NUMBER",
|
||||
"VAT_NUMBER"
|
||||
],
|
||||
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "ExtraParamValue",
|
||||
"type": "string",
|
||||
"max_length": 2048,
|
||||
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
||||
},
|
||||
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
||||
}
|
||||
},
|
||||
"sensitive": true,
|
||||
"documentation": "\n<p>Provides detailed contact information.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>, <code>LastName</code>, <code>ContactType</code>, <code>OrganizationName</code>, <code>AddressLine1</code>, <code>AddressLine2</code>, <code>City</code>, <code>State</code>, <code>CountryCode</code>, <code>ZipCode</code>, <code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>, <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"TechContact": {
|
||||
"shape_name": "ContactDetail",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FirstName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"LastName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ContactType": {
|
||||
"shape_name": "ContactType",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"PERSON",
|
||||
"COMPANY",
|
||||
"ASSOCIATION",
|
||||
"PUBLIC_BODY",
|
||||
"RESELLER"
|
||||
],
|
||||
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"OrganizationName": {
|
||||
"shape_name": "ContactName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"AddressLine1": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"AddressLine2": {
|
||||
"shape_name": "AddressLine",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"City": {
|
||||
"shape_name": "City",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"State": {
|
||||
"shape_name": "State",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"CountryCode": {
|
||||
"shape_name": "CountryCode",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"AD",
|
||||
"AE",
|
||||
"AF",
|
||||
"AG",
|
||||
"AI",
|
||||
"AL",
|
||||
"AM",
|
||||
"AN",
|
||||
"AO",
|
||||
"AQ",
|
||||
"AR",
|
||||
"AS",
|
||||
"AT",
|
||||
"AU",
|
||||
"AW",
|
||||
"AZ",
|
||||
"BA",
|
||||
"BB",
|
||||
"BD",
|
||||
"BE",
|
||||
"BF",
|
||||
"BG",
|
||||
"BH",
|
||||
"BI",
|
||||
"BJ",
|
||||
"BL",
|
||||
"BM",
|
||||
"BN",
|
||||
"BO",
|
||||
"BR",
|
||||
"BS",
|
||||
"BT",
|
||||
"BW",
|
||||
"BY",
|
||||
"BZ",
|
||||
"CA",
|
||||
"CC",
|
||||
"CD",
|
||||
"CF",
|
||||
"CG",
|
||||
"CH",
|
||||
"CI",
|
||||
"CK",
|
||||
"CL",
|
||||
"CM",
|
||||
"CN",
|
||||
"CO",
|
||||
"CR",
|
||||
"CU",
|
||||
"CV",
|
||||
"CX",
|
||||
"CY",
|
||||
"CZ",
|
||||
"DE",
|
||||
"DJ",
|
||||
"DK",
|
||||
"DM",
|
||||
"DO",
|
||||
"DZ",
|
||||
"EC",
|
||||
"EE",
|
||||
"EG",
|
||||
"ER",
|
||||
"ES",
|
||||
"ET",
|
||||
"FI",
|
||||
"FJ",
|
||||
"FK",
|
||||
"FM",
|
||||
"FO",
|
||||
"FR",
|
||||
"GA",
|
||||
"GB",
|
||||
"GD",
|
||||
"GE",
|
||||
"GH",
|
||||
"GI",
|
||||
"GL",
|
||||
"GM",
|
||||
"GN",
|
||||
"GQ",
|
||||
"GR",
|
||||
"GT",
|
||||
"GU",
|
||||
"GW",
|
||||
"GY",
|
||||
"HK",
|
||||
"HN",
|
||||
"HR",
|
||||
"HT",
|
||||
"HU",
|
||||
"ID",
|
||||
"IE",
|
||||
"IL",
|
||||
"IM",
|
||||
"IN",
|
||||
"IQ",
|
||||
"IR",
|
||||
"IS",
|
||||
"IT",
|
||||
"JM",
|
||||
"JO",
|
||||
"JP",
|
||||
"KE",
|
||||
"KG",
|
||||
"KH",
|
||||
"KI",
|
||||
"KM",
|
||||
"KN",
|
||||
"KP",
|
||||
"KR",
|
||||
"KW",
|
||||
"KY",
|
||||
"KZ",
|
||||
"LA",
|
||||
"LB",
|
||||
"LC",
|
||||
"LI",
|
||||
"LK",
|
||||
"LR",
|
||||
"LS",
|
||||
"LT",
|
||||
"LU",
|
||||
"LV",
|
||||
"LY",
|
||||
"MA",
|
||||
"MC",
|
||||
"MD",
|
||||
"ME",
|
||||
"MF",
|
||||
"MG",
|
||||
"MH",
|
||||
"MK",
|
||||
"ML",
|
||||
"MM",
|
||||
"MN",
|
||||
"MO",
|
||||
"MP",
|
||||
"MR",
|
||||
"MS",
|
||||
"MT",
|
||||
"MU",
|
||||
"MV",
|
||||
"MW",
|
||||
"MX",
|
||||
"MY",
|
||||
"MZ",
|
||||
"NA",
|
||||
"NC",
|
||||
"NE",
|
||||
"NG",
|
||||
"NI",
|
||||
"NL",
|
||||
"NO",
|
||||
"NP",
|
||||
"NR",
|
||||
"NU",
|
||||
"NZ",
|
||||
"OM",
|
||||
"PA",
|
||||
"PE",
|
||||
"PF",
|
||||
"PG",
|
||||
"PH",
|
||||
"PK",
|
||||
"PL",
|
||||
"PM",
|
||||
"PN",
|
||||
"PR",
|
||||
"PT",
|
||||
"PW",
|
||||
"PY",
|
||||
"QA",
|
||||
"RO",
|
||||
"RS",
|
||||
"RU",
|
||||
"RW",
|
||||
"SA",
|
||||
"SB",
|
||||
"SC",
|
||||
"SD",
|
||||
"SE",
|
||||
"SG",
|
||||
"SH",
|
||||
"SI",
|
||||
"SK",
|
||||
"SL",
|
||||
"SM",
|
||||
"SN",
|
||||
"SO",
|
||||
"SR",
|
||||
"ST",
|
||||
"SV",
|
||||
"SY",
|
||||
"SZ",
|
||||
"TC",
|
||||
"TD",
|
||||
"TG",
|
||||
"TH",
|
||||
"TJ",
|
||||
"TK",
|
||||
"TL",
|
||||
"TM",
|
||||
"TN",
|
||||
"TO",
|
||||
"TR",
|
||||
"TT",
|
||||
"TV",
|
||||
"TW",
|
||||
"TZ",
|
||||
"UA",
|
||||
"UG",
|
||||
"US",
|
||||
"UY",
|
||||
"UZ",
|
||||
"VA",
|
||||
"VC",
|
||||
"VE",
|
||||
"VG",
|
||||
"VI",
|
||||
"VN",
|
||||
"VU",
|
||||
"WF",
|
||||
"WS",
|
||||
"YE",
|
||||
"YT",
|
||||
"ZA",
|
||||
"ZM",
|
||||
"ZW"
|
||||
],
|
||||
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"ZipCode": {
|
||||
"shape_name": "ZipCode",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"PhoneNumber": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Email": {
|
||||
"shape_name": "Email",
|
||||
"type": "string",
|
||||
"max_length": 254,
|
||||
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
||||
},
|
||||
"Fax": {
|
||||
"shape_name": "ContactNumber",
|
||||
"type": "string",
|
||||
"max_length": 30,
|
||||
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
||||
},
|
||||
"ExtraParams": {
|
||||
"shape_name": "ExtraParamList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "ExtraParam",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "ExtraParamName",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DUNS_NUMBER",
|
||||
"BRAND_NUMBER",
|
||||
"BIRTH_DEPARTMENT",
|
||||
"BIRTH_DATE_IN_YYYY_MM_DD",
|
||||
"BIRTH_COUNTRY",
|
||||
"BIRTH_CITY",
|
||||
"DOCUMENT_NUMBER",
|
||||
"AU_ID_NUMBER",
|
||||
"AU_ID_TYPE",
|
||||
"CA_LEGAL_TYPE",
|
||||
"FI_BUSINESS_NUMBER",
|
||||
"FI_ID_NUMBER",
|
||||
"IT_PIN",
|
||||
"RU_PASSPORT_DATA",
|
||||
"SE_ID_NUMBER",
|
||||
"SG_ID_NUMBER",
|
||||
"VAT_NUMBER"
|
||||
],
|
||||
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"Value": {
|
||||
"shape_name": "ExtraParamValue",
|
||||
"type": "string",
|
||||
"max_length": 2048,
|
||||
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
||||
},
|
||||
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
||||
}
|
||||
},
|
||||
"sensitive": true,
|
||||
"documentation": "\n<p>Provides detailed contact information.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>, <code>LastName</code>, <code>ContactType</code>, <code>OrganizationName</code>, <code>AddressLine1</code>, <code>AddressLine2</code>, <code>City</code>, <code>State</code>, <code>CountryCode</code>, <code>ZipCode</code>, <code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>, <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n"
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The UpdateDomainContact request includes the following elements.</p>\n"
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "UpdateDomainContactResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"OperationId": {
|
||||
"shape_name": "OperationId",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.</p>\n <p>Type: String</p>\n <p>Default: None</p>\n <p>Constraints: Maximum 255 characters.</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The UpdateDomainContact response includes the following element.</p>\n"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "DuplicateRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The request is already in progress for the domain.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "TLDRulesViolation",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The top-level domain does not support this operation.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "OperationLimitExceeded",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The number of operations or jobs running exceeded the allowed threshold for the account.</p>\n"
|
||||
}
|
||||
],
|
||||
"documentation": "\n<p>This operation updates the contact information for a particular domain.\nInformation for at least one contact (registrant, administrator, or technical) must be\nsupplied for update.</p>\n<p>If the update is successful, this method returns an operation ID that you can use to\ntrack the progress and completion of the action. If the request is not completed\nsuccessfully, the domain registrant will be notified by email.</p>\n<examples>\n<example>\n<name>UpdateDomainContact Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.UpdateDomainContact\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"DomainName\":\"example.com\",\n \"RegistrantContact\":{\n \"FirstName\":\"John\",\n \"MiddleName\":\"Richard\",\n \"LastName\":\"Doe\",\n \"ContactType\":\"PERSON\",\n \"OrganizationName\":\"\",\n \"AddressLine1\":\"123 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Any Town\",\n \"State\":\"WA\",\n \"CountryCode\":\"US\",\n \"ZipCode\":\"98101\",\n \"PhoneNumber\":\"+2065550100\",\n \"Email\":\"john@example.com\",\n \"Fax\":\"+2065550101\"\n },\n \"AdminContact\":{\n \"FirstName\":\"John\",\n \"MiddleName\":\"Richard\",\n \"LastName\":\"Doe\",\n \"ContactType\":\"PERSON\",\n \"OrganizationName\":\"\",\n \"AddressLine1\":\"123 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Any Town\",\n \"State\":\"WA\",\n \"CountryCode\":\"US\",\n \"ZipCode\":\"98101\",\n \"PhoneNumber\":\"+2065550100\",\n \"Email\":\"john@example.com\",\n \"Fax\":\"+2065550101\"\n },\n \"TechContact\":{\n \"FirstName\":\"John\",\n \"MiddleName\":\"Richard\",\n \"LastName\":\"Doe\",\n \"ContactType\":\"PERSON\",\n \"OrganizationName\":\"\",\n \"AddressLine1\":\"123 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Any Town\",\n \"State\":\"WA\",\n \"CountryCode\":\"US\",\n \"ZipCode\":\"98101\",\n \"PhoneNumber\":\"+2065550100\",\n \"Email\":\"john@example.com\",\n \"Fax\":\"+2065550101\"\n },\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n\"OperationId\":\"308c56712-faa4-40fe-94c8-b423069de3f6\"\n}</response>\n</example>\n</examples>\n"
|
||||
},
|
||||
"UpdateDomainContactPrivacy": {
|
||||
"name": "UpdateDomainContactPrivacy",
|
||||
"input": {
|
||||
"shape_name": "UpdateDomainContactPrivacyRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"DomainName": {
|
||||
"shape_name": "DomainName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"pattern": "[a-zA-Z0-9_\\-.]*",
|
||||
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"AdminPrivacy": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n<p>Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.</p>\n<p>Type: Boolean</p>\n<p>Default: None</p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Required: No</p>\n\n"
|
||||
},
|
||||
"RegistrantPrivacy": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n<p>Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.</p>\n<p>Type: Boolean</p>\n<p>Default: None</p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Required: No</p>\n\n"
|
||||
},
|
||||
"TechPrivacy": {
|
||||
"shape_name": "Boolean",
|
||||
"type": "boolean",
|
||||
"documentation": "\n<p>Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.</p>\n<p>Type: Boolean</p>\n<p>Default: None</p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Required: No</p>\n\n"
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The UpdateDomainContactPrivacy request includes the following elements.</p>\n"
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "UpdateDomainContactPrivacyResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"OperationId": {
|
||||
"shape_name": "OperationId",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.</p>\n <p>Type: String</p>\n <p>Default: None</p>\n <p>Constraints: Maximum 255 characters.</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The UpdateDomainContactPrivacy response includes the following element.</p>\n"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "DuplicateRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The request is already in progress for the domain.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "TLDRulesViolation",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The top-level domain does not support this operation.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "OperationLimitExceeded",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The number of operations or jobs running exceeded the allowed threshold for the account.</p>\n"
|
||||
}
|
||||
],
|
||||
"documentation": "\n<p>This operation updates the specified domain contact's privacy setting. When the privacy\noption is enabled, personal information such as postal or email address is hidden from the\nresults of a public WHOIS query. The privacy services are provided by the AWS registrar,\nGandi. For more information, see the <a href=\"http://www.gandi.net/domain/whois/?currency=USD&amp;lang=en\">Gandi privacy\nfeatures</a>.</p>\n<p>This operation only affects the privacy of the specified contact type (registrant, administrator, or tech). Successful acceptance returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.</p>\n<examples>\n<example>\n<name>UpdateDomainContactPrivacy Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.UpdateDomainContactPrivacy\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n\"DomainName\":\"example.com\",\n\"AdminPrivacy\":true,\n\"RegistrantPrivacy\":true,\n\"TechPrivacy\":true,\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n\"OperationId\":\"777bc5da-fbf7-482c-b2ba-8946884a7dd6\"\n}</response>\n</example>\n</examples>\n"
|
||||
},
|
||||
"UpdateDomainNameservers": {
|
||||
"name": "UpdateDomainNameservers",
|
||||
"input": {
|
||||
"shape_name": "UpdateDomainNameserversRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"DomainName": {
|
||||
"shape_name": "DomainName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"pattern": "[a-zA-Z0-9_\\-.]*",
|
||||
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
},
|
||||
"Nameservers": {
|
||||
"shape_name": "NameserverList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Nameserver",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"shape_name": "HostName",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"pattern": "[a-zA-Z0-9_\\-.]*",
|
||||
"documentation": "\n<p>The fully qualified host name of the name server.</p>\n<p>Type: String</p>\n<p>Constraint: Maximum 255 characterss</p>\n<p>Parent: <code>Nameservers</code></p>\n",
|
||||
"required": true
|
||||
},
|
||||
"GlueIps": {
|
||||
"shape_name": "GlueIpList",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "GlueIp",
|
||||
"type": "string",
|
||||
"max_length": 45,
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "\n<p>Glue IP address of a name server entry. Glue IP addresses are required only when the name of the\nname server is a subdomain of the domain. For example, if your domain is example.com and the name\nserver for the domain is ns.example.com, you need to specify the IP address for ns.example.com.</p>\n<p>Type: List of IP addresses.</p>\n<p>Constraints: The list can contain only one IPv4 and one IPv6 address.</p>\n<p>Parent: <code>Nameservers</code></p>\n"
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>Nameserver includes the following elements.</p>\n"
|
||||
},
|
||||
"documentation": "\n<p>A list of new name servers for the domain.</p>\n<p>Type: Complex</p>\n<p>Children: <code>Name</code>, <code>GlueIps</code></p>\n<p>Required: Yes</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The UpdateDomainNameserver request includes the following elements.</p>\n"
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "UpdateDomainNameserversResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"OperationId": {
|
||||
"shape_name": "OperationId",
|
||||
"type": "string",
|
||||
"max_length": 255,
|
||||
"documentation": "\n<p>Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.</p>\n <p>Type: String</p>\n <p>Default: None</p>\n <p>Constraints: Maximum 255 characters.</p>\n",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n<p>The UpdateDomainNameservers response includes the following element.</p>\n"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InvalidInput",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "DuplicateRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The request is already in progress for the domain.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "TLDRulesViolation",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The top-level domain does not support this operation.</p>\n"
|
||||
},
|
||||
{
|
||||
"shape_name": "OperationLimitExceeded",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": null
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The number of operations or jobs running exceeded the allowed threshold for the account.</p>\n"
|
||||
}
|
||||
],
|
||||
"documentation": "\n<p>This operation replaces the current set of name servers for the domain with the specified set of name servers.\nIf you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone\nfor the domain. </p>\n<p>If successful, this operation returns an operation ID that you can use to track the progress and completion of the action.\nIf the request is not completed successfully, the domain registrant will be notified by email.</p>\n<examples>\n<example>\n<name>UpdateDomainNameservers Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.UpdateDomainNameservers\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"DomainName\":\"example.com\",\n \"Nameservers\":[\n {\n \"Name\":\"ns1.example.net\"\n },\n {\n \"Name\":\"ns1.example.com\",\n \"GlueIps\":[\n \"192.0.2.44\"\n ]\n }\n ]\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n \"OperationId\":\"0b370c79-faa4-40fe-94c8-b423069de3f6\"\n}</response>\n</example>\n</examples>\n\n"
|
||||
}
|
||||
},
|
||||
"retry": {
|
||||
"__default__": {
|
||||
"max_attempts": 5,
|
||||
"delay": {
|
||||
"type": "exponential",
|
||||
"base": "rand",
|
||||
"growth_factor": 2
|
||||
},
|
||||
"policies": {
|
||||
"general_socket_errors": {
|
||||
"applies_when": {
|
||||
"socket_errors": [
|
||||
"GENERAL_CONNECTION_ERROR"
|
||||
]
|
||||
}
|
||||
},
|
||||
"general_server_error": {
|
||||
"applies_when": {
|
||||
"response": {
|
||||
"http_status_code": 500
|
||||
}
|
||||
}
|
||||
},
|
||||
"service_unavailable": {
|
||||
"applies_when": {
|
||||
"response": {
|
||||
"http_status_code": 503
|
||||
}
|
||||
}
|
||||
},
|
||||
"limit_exceeded": {
|
||||
"applies_when": {
|
||||
"response": {
|
||||
"http_status_code": 509
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -3817,6 +3817,11 @@
|
|||
"output_token": "NextPartNumberMarker",
|
||||
"input_token": "PartNumberMarker",
|
||||
"result_key": "Parts",
|
||||
"non_aggregate_keys": [
|
||||
"Initiator",
|
||||
"Owner",
|
||||
"StorageClass"
|
||||
],
|
||||
"py_input_token": "part_number_marker"
|
||||
}
|
||||
},
|
||||
|
|
@ -5697,6 +5702,11 @@
|
|||
"output_token": "NextPartNumberMarker",
|
||||
"input_token": "PartNumberMarker",
|
||||
"result_key": "Parts",
|
||||
"non_aggregate_keys": [
|
||||
"Initiator",
|
||||
"Owner",
|
||||
"StorageClass"
|
||||
],
|
||||
"py_input_token": "part_number_marker"
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -7,8 +7,126 @@
|
|||
"service_full_name": "AWS Support",
|
||||
"endpoint_prefix": "support",
|
||||
"xmlnamespace": "http://support.amazonaws.com/doc/2013-04-15/",
|
||||
"documentation": "\n <fullname>AWS Support</fullname>\n \n \n <p>The AWS Support API reference is intended for programmers who need detailed information about the AWS Support actions and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.</p>\n \n <p>The AWS Support service also exposes a set of <a href=\"https://aws.amazon.com/support/trustedadvisor\">Trusted Advisor</a> features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks. </p> \n \n <p>The following list describes the AWS Support case management actions: </p>\n <ul>\n <li>\n<b>Service names, issue categories, and available severity levels. </b>The actions <a>DescribeServices</a> and <a>DescribeSeverityLevels</a> enable you to obtain AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the <a>CreateCase</a> action. </li>\n <li>\n<b>Case creation, case details, and case resolution.</b> The actions <a>CreateCase</a>, <a>DescribeCases</a>, and <a>ResolveCase</a> enable you to create AWS Support cases, retrieve them, and resolve them.</li>\n <li>\n<b>Case communication.</b> The actions <a>DescribeCommunications</a> and <a>AddCommunicationToCase</a> enable you to retrieve and add communication to AWS Support cases. </li>\n </ul>\n \n <p>The following list describes the actions available from the AWS Support service for Trusted Advisor:</p>\n <ul>\n <li>\n<a>DescribeTrustedAdvisorChecks</a> returns the list of checks that run against your AWS resources.</li> \n <li>Using the CheckId for a specific check returned by DescribeTrustedAdvisorChecks, you can call <a>DescribeTrustedAdvisorCheckResult</a> to obtain the results for the check you specified.</li> \n <li>\n<a>DescribeTrustedAdvisorCheckSummaries</a> returns summarized results for one or more Trusted Advisor checks.</li>\n <li>\n<a>RefreshTrustedAdvisorCheck</a> requests that Trusted Advisor rerun a specified check. </li>\n <li>\n<a>DescribeTrustedAdvisorCheckRefreshStatuses</a> reports the refresh status of one or more checks. </li>\n </ul>\n \n <p>For authentication of requests, AWS Support uses <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing Process</a>.</p>\n \n <p>See the AWS Support <a href=\"http://docs.aws.amazon.com/awssupport/latest/user/Welcome.html\">User Guide</a> for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources. </p>\n \n \n ",
|
||||
"documentation": "\n <fullname>AWS Support</fullname>\n \n \n <p>The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.</p>\n \n <p>The AWS Support service also exposes a set of <a href=\"https://aws.amazon.com/support/trustedadvisor\">Trusted Advisor</a> features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks. </p> \n \n <p>The following list describes the AWS Support case management operations: </p>\n <ul>\n <li>\n<b>Service names, issue categories, and available severity levels. </b>The <a>DescribeServices</a> and <a>DescribeSeverityLevels</a> operations return AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the <a>CreateCase</a> operation. </li>\n <li>\n<b>Case creation, case details, and case resolution.</b> The <a>CreateCase</a>, <a>DescribeCases</a>, <a>DescribeAttachment</a>, and <a>ResolveCase</a> operations create AWS Support cases, retrieve information about cases, and resolve cases.</li>\n <li>\n<b>Case communication.</b> The <a>DescribeCommunications</a>, <a>AddCommunicationToCase</a>, and <a>AddAttachmentsToSet</a> operations retrieve and add communications and attachments to AWS Support cases. </li>\n </ul>\n \n <p>The following list describes the operations available from the AWS Support service for Trusted Advisor:</p>\n <ul>\n <li>\n<a>DescribeTrustedAdvisorChecks</a> returns the list of checks that run against your AWS resources.</li> \n <li>Using the <code>CheckId</code> for a specific check returned by <a>DescribeTrustedAdvisorChecks</a>, you can call <a>DescribeTrustedAdvisorCheckResult</a> to obtain the results for the check you specified.</li> \n <li>\n<a>DescribeTrustedAdvisorCheckSummaries</a> returns summarized results for one or more Trusted Advisor checks.</li>\n <li>\n<a>RefreshTrustedAdvisorCheck</a> requests that Trusted Advisor rerun a specified check. </li>\n <li>\n<a>DescribeTrustedAdvisorCheckRefreshStatuses</a> reports the refresh status of one or more checks. </li>\n </ul>\n \n <p>For authentication of requests, AWS Support uses <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing Process</a>.</p>\n \n <p>See <a href=\"http://docs.aws.amazon.com/awssupport/latest/user/Welcome.html\">About the AWS Support API</a> in the <i>AWS Support User Guide</i> for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources. </p>\n \n \n ",
|
||||
"operations": {
|
||||
"AddAttachmentsToSet": {
|
||||
"name": "AddAttachmentsToSet",
|
||||
"input": {
|
||||
"shape_name": "AddAttachmentsToSetRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"attachmentSetId": {
|
||||
"shape_name": "AttachmentSetId",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of the attachment set. If an <code>AttachmentSetId</code> is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>AttachmentSetId</code> is specified, the attachments are added to the specified set, if it exists.</p>\n "
|
||||
},
|
||||
"attachments": {
|
||||
"shape_name": "Attachments",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "Attachment",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"fileName": {
|
||||
"shape_name": "FileName",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the attachment file.</p>\n "
|
||||
},
|
||||
"data": {
|
||||
"shape_name": "Data",
|
||||
"type": "blob",
|
||||
"documentation": "\n <p>The content of the attachment file.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>An attachment to a case communication. The attachment consists of the file name and the content of the file.</p>\n "
|
||||
},
|
||||
"documentation": "\n <p>One or more attachments to add to the set. The limit is 3 attachments per set, and the size limit is 5 MB per attachment.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "AddAttachmentsToSetResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"attachmentSetId": {
|
||||
"shape_name": "AttachmentSetId",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of the attachment set. If an <code>AttachmentSetId</code> was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>AttachmentSetId</code> was specified, the attachments are added to the specified set, if it exists.</p>\n "
|
||||
},
|
||||
"expiryTime": {
|
||||
"shape_name": "ExpiryTime",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The time and date when the attachment set expires.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The ID and expiry time of the attachment set returned by the <a>AddAttachmentsToSet</a> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InternalServerError",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "AttachmentSetIdNotFound",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>An attachment set with the specified ID could not be found.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>An attachment set with the specified ID could not be found.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "AttachmentSetExpired",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The expiration time of the attachment set has passed. The set expires 1 hour after it is created.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The expiration time of the attachment set has passed. The set expires 1 hour after it is created.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "AttachmentSetSizeLimitExceeded",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.</p> \n "
|
||||
},
|
||||
{
|
||||
"shape_name": "AttachmentLimitExceeded",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The limit for the number of attachment sets created in a short period of time has been exceeded.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The limit for the number of attachment sets created in a short period of time has been exceeded.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Adds one or more attachments to an attachment set. If an <code>AttachmentSetId</code> is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>AttachmentSetId</code> is specified, the attachments are added to the specified set, if it exists.</p>\n <p>An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the <code>ExpiryTime</code> returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB.</p>\n "
|
||||
},
|
||||
"AddCommunicationToCase": {
|
||||
"name": "AddCommunicationToCase",
|
||||
"input": {
|
||||
|
|
@ -39,6 +157,11 @@
|
|||
"min_length": 0,
|
||||
"max_length": 10,
|
||||
"documentation": "\n <p>The email addresses in the CC line of an email to be added to the support case.</p>\n "
|
||||
},
|
||||
"attachmentSetId": {
|
||||
"shape_name": "AttachmentSetId",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling <a>AddAttachmentsToSet</a></p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>To be written.</p>\n "
|
||||
|
|
@ -53,7 +176,7 @@
|
|||
"documentation": "\n <p>True if <a>AddCommunicationToCase</a> succeeds. Otherwise, returns an error.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Contains the following objects or data if successful. Otherwise, returns an error.</p>\n "
|
||||
"documentation": "\n <p>The result of the <a>AddCommunicationToCase</a> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
|
|
@ -79,6 +202,30 @@
|
|||
}
|
||||
},
|
||||
"documentation": "\n <p>The requested <code>CaseId</code> could not be located.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "AttachmentSetIdNotFound",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>An attachment set with the specified ID could not be found.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>An attachment set with the specified ID could not be found.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "AttachmentSetExpired",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The expiration time of the attachment set has passed. The set expires 1 hour after it is created.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The expiration time of the attachment set has passed. The set expires 1 hour after it is created.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Adds additional customer communication to an AWS Support case. You use the <code>CaseId</code> value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the <code>CcEmailAddresses</code> value. The <code>CommunicationBody</code> value contains the text of the communication.</p>\n <p>The response indicates the success or failure of the request.</p>\n <p>This operation implements a subset of the behavior on the AWS Support <a href=\"https://aws.amazon.com/support\">Your Support Cases</a> web form.</p>\n "
|
||||
|
|
@ -140,6 +287,11 @@
|
|||
"shape_name": "IssueType",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The type of issue for the case. You can specify either \"customer-service\" or \"technical.\" If you do not indicate a value, the default is \"technical.\" </p>\n "
|
||||
},
|
||||
"attachmentSetId": {
|
||||
"shape_name": "AttachmentSetId",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of a set of one or more attachments for the case. Create the set by using <a>AddAttachmentsToSet</a>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n \n "
|
||||
|
|
@ -154,7 +306,7 @@
|
|||
"documentation": "\n <p>The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i></p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The AWS Support case ID returned by a successful completion of the <a>CreateCase</a> action. </p>\n "
|
||||
"documentation": "\n <p>The AWS Support case ID returned by a successful completion of the <a>CreateCase</a> operation. </p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
|
|
@ -180,9 +332,112 @@
|
|||
}
|
||||
},
|
||||
"documentation": "\n <p>The case creation limit for the account has been exceeded. </p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "AttachmentSetIdNotFound",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>An attachment set with the specified ID could not be found.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>An attachment set with the specified ID could not be found.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "AttachmentSetExpired",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The expiration time of the attachment set has passed. The set expires 1 hour after it is created.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The expiration time of the attachment set has passed. The set expires 1 hour after it is created.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page. Its parameters require you to specify the following information: </p>\n <ol>\n <li>\n<b>ServiceCode.</b> The code for an AWS service. You obtain the <code>ServiceCode</code> by calling <a>DescribeServices</a>. </li>\n <li>\n<b>CategoryCode.</b> The category for the service defined for the <code>ServiceCode</code> value. You also obtain the category code for a service by calling <a>DescribeServices</a>. Each AWS service defines its own set of category codes. </li>\n <li>\n<b>SeverityCode.</b> A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling <a>DescribeSeverityLevels</a>.</li>\n <li>\n<b>Subject.</b> The <b>Subject</b> field on the AWS Support Center <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page.</li>\n <li>\n<b>CommunicationBody.</b> The <b>Description</b> field on the AWS Support Center <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page.</li>\n <li>\n<b>Language.</b> The human language in which AWS Support handles the case. English and Japanese are currently supported.</li>\n <li>\n<b>CcEmailAddresses.</b> The AWS Support Center <b>CC</b> field on the <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an <a href=\"http://aws.amazon.com/tools/\">AWS SDK</a>. </li>\n <li>\n<b>IssueType.</b> The type of issue for the case. You can specify either \"customer-service\" or \"technical.\" If you do not indicate a value, the default is \"technical.\" </li>\n</ol>\n \n <note><p>The AWS Support API does not currently support the ability to add attachments to cases. You can, however, call <a>AddCommunicationToCase</a> to add information to an open case.</p> </note>\n \n <p>A successful <a>CreateCase</a> request returns an AWS Support case number. Case numbers are used by the <a>DescribeCases</a> action to retrieve existing AWS Support cases. </p>\n \n \n "
|
||||
"documentation": "\n <p>Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page. Its parameters require you to specify the following information: </p>\n <ol>\n <li>\n<b>IssueType.</b> The type of issue for the case. You can specify either \"customer-service\" or \"technical.\" If you do not indicate a value, the default is \"technical.\" </li>\n <li>\n<b>ServiceCode.</b> The code for an AWS service. You obtain the <code>ServiceCode</code> by calling <a>DescribeServices</a>. </li>\n <li>\n<b>CategoryCode.</b> The category for the service defined for the <code>ServiceCode</code> value. You also obtain the category code for a service by calling <a>DescribeServices</a>. Each AWS service defines its own set of category codes. </li>\n <li>\n<b>SeverityCode.</b> A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling <a>DescribeSeverityLevels</a>.</li>\n <li>\n<b>Subject.</b> The <b>Subject</b> field on the AWS Support Center <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page.</li>\n <li>\n<b>CommunicationBody.</b> The <b>Description</b> field on the AWS Support Center <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page.</li>\n <li>\n<b>AttachmentSetId.</b> The ID of a set of attachments that has been created by using <a>AddAttachmentsToSet</a>.</li>\n <li>\n<b>Language.</b> The human language in which AWS Support handles the case. English and Japanese are currently supported.</li>\n <li>\n<b>CcEmailAddresses.</b> The AWS Support Center <b>CC</b> field on the <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an <a href=\"http://aws.amazon.com/tools/\">AWS SDK</a>. </li>\n </ol>\n \n <note><p>To add additional communication or attachments to an existing case, use <a>AddCommunicationToCase</a>.</p> </note>\n \n <p>A successful <a>CreateCase</a> request returns an AWS Support case number. Case numbers are used by the <a>DescribeCases</a> operation to retrieve existing AWS Support cases. </p>\n \n \n "
|
||||
},
|
||||
"DescribeAttachment": {
|
||||
"name": "DescribeAttachment",
|
||||
"input": {
|
||||
"shape_name": "DescribeAttachmentRequest",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"attachmentId": {
|
||||
"shape_name": "AttachmentId",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of the attachment to return. Attachment IDs are returned by the <a>DescribeCommunications</a> operation.</p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n\n "
|
||||
},
|
||||
"output": {
|
||||
"shape_name": "DescribeAttachmentResponse",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"attachment": {
|
||||
"shape_name": "Attachment",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"fileName": {
|
||||
"shape_name": "FileName",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The name of the attachment file.</p>\n "
|
||||
},
|
||||
"data": {
|
||||
"shape_name": "Data",
|
||||
"type": "blob",
|
||||
"documentation": "\n <p>The content of the attachment file.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The attachment content and file name.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The content and file name of the attachment returned by the <a>DescribeAttachment</a> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape_name": "InternalServerError",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "DescribeAttachmentLimitExceeded",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The limit for the number of <a>DescribeAttachment</a> requests in a short period of time has been exceeded.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The limit for the number of <a>DescribeAttachment</a> requests in a short period of time has been exceeded.</p>\n "
|
||||
},
|
||||
{
|
||||
"shape_name": "AttachmentIdNotFound",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape_name": "ErrorMessage",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>An attachment with the specified ID could not be found.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>An attachment with the specified ID could not be found.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the <a>AttachmentDetails</a> objects that are returned by the <a>DescribeCommunications</a> operation.</p>\n "
|
||||
},
|
||||
"DescribeCases": {
|
||||
"name": "DescribeCases",
|
||||
|
|
@ -210,17 +465,17 @@
|
|||
"afterTime": {
|
||||
"shape_name": "AfterTime",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The start date for a filtered date search on support case communications.</p>\n "
|
||||
"documentation": "\n <p>The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>\n "
|
||||
},
|
||||
"beforeTime": {
|
||||
"shape_name": "BeforeTime",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The end date for a filtered date search on support case communications.</p>\n "
|
||||
"documentation": "\n <p>The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>\n "
|
||||
},
|
||||
"includeResolvedCases": {
|
||||
"shape_name": "IncludeResolvedCases",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Specifies whether resolved support cases should be included in the <a>DescribeCases</a> results.</p>\n "
|
||||
"documentation": "\n <p>Specifies whether resolved support cases should be included in the <a>DescribeCases</a> results. The default is <i>false</i>.</p>\n "
|
||||
},
|
||||
"nextToken": {
|
||||
"shape_name": "NextToken",
|
||||
|
|
@ -238,6 +493,11 @@
|
|||
"shape_name": "Language",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>\n "
|
||||
},
|
||||
"includeCommunications": {
|
||||
"shape_name": "IncludeCommunications",
|
||||
"type": "boolean",
|
||||
"documentation": "\n <p>Specifies whether communications should be included in the <a>DescribeCases</a> results. The default is <i>true</i>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n \n "
|
||||
|
|
@ -327,10 +587,32 @@
|
|||
"timeCreated": {
|
||||
"shape_name": "TimeCreated",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The time the support case was created. </p>\n "
|
||||
"documentation": "\n <p>The time the communication was created. </p>\n "
|
||||
},
|
||||
"attachmentSet": {
|
||||
"shape_name": "AttachmentSet",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "AttachmentDetails",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"attachmentId": {
|
||||
"shape_name": "AttachmentId",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of the attachment.</p>\n"
|
||||
},
|
||||
"fileName": {
|
||||
"shape_name": "FileName",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The file name of the attachment.</p>\n"
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the <a>DescribeAttachment</a> operation.</p>\n"
|
||||
},
|
||||
"documentation": "\n <p>Information about the attachments to the case communication. </p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Exposes the fields used by a communication for an AWS Support case.</p>\n "
|
||||
"documentation": "\n <p>A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication.</p>\n "
|
||||
},
|
||||
"documentation": "\n <p>The five most recent communications associated with the case.</p>\n "
|
||||
},
|
||||
|
|
@ -340,7 +622,7 @@
|
|||
"documentation": "\n <p>A resumption point for pagination.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The five most recent communications between you and AWS Support Center. Includes a <code>nextToken</code> to retrieve the next set of communications.</p>\n "
|
||||
"documentation": "\n <p>The five most recent communications between you and AWS Support Center, including the IDs of any attachments to the communications. Also includes a <code>nextToken</code> that you can use to retrieve earlier communications.</p>\n "
|
||||
},
|
||||
"ccEmailAddresses": {
|
||||
"shape_name": "CcEmailAddressList",
|
||||
|
|
@ -358,7 +640,7 @@
|
|||
"documentation": "\n <p>The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>A JSON-formatted object that contains the metadata for a support case. It is contained the response from a <a>DescribeCases</a> request. <b>CaseDetails</b> contains the following fields:</p>\n <ol>\n <li>\n<b>CaseID.</b> The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i>.</li>\n <li>\n<b>CategoryCode.</b> The category of problem for the AWS Support case. Corresponds to the CategoryCode values returned by a call to <a>DescribeServices</a>.</li>\n <li>\n<b>DisplayId.</b> The identifier for the case on pages in the AWS Support Center.</li>\n <li>\n<b>Language.</b> The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</li>\n <li>\n<b>RecentCommunications.</b> One or more <a>Communication</a> objects. Fields of these objects are <code>Body</code>, <code>CaseId</code>, <code>SubmittedBy</code>, and <code>TimeCreated</code>.</li> \n <li>\n<b>NextToken.</b> A resumption point for pagination.</li>\n <li>\n<b>ServiceCode.</b> The identifier for the AWS service that corresponds to the service code defined in the call to <a>DescribeServices</a>.</li>\n <li>\n<b>SeverityCode. </b>The severity code assigned to the case. Contains one of the values returned by the call to <a>DescribeSeverityLevels</a>.</li>\n <li>\n<b>Status.</b> The status of the case in the AWS Support Center.</li>\n <li>\n<b>Subject.</b> The subject line of the case.</li>\n <li>\n<b>SubmittedBy.</b> The email address of the account that submitted the case.</li>\n <li>\n<b>TimeCreated.</b> The time the case was created, in ISO-8601 format.</li>\n </ol>\n \n "
|
||||
"documentation": "\n <p>A JSON-formatted object that contains the metadata for a support case. It is contained the response from a <a>DescribeCases</a> request. <b>CaseDetails</b> contains the following fields:</p>\n <ol>\n <li>\n<b>CaseID.</b> The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i>.</li>\n <li>\n<b>CategoryCode.</b> The category of problem for the AWS Support case. Corresponds to the CategoryCode values returned by a call to <a>DescribeServices</a>.</li>\n <li>\n<b>DisplayId.</b> The identifier for the case on pages in the AWS Support Center.</li>\n <li>\n<b>Language.</b> The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.</li>\n <li>\n<b>RecentCommunications.</b> One or more <a>Communication</a> objects. Fields of these objects are <code>Attachments</code>, <code>Body</code>, <code>CaseId</code>, <code>SubmittedBy</code>, and <code>TimeCreated</code>.</li> \n <li>\n<b>NextToken.</b> A resumption point for pagination.</li>\n <li>\n<b>ServiceCode.</b> The identifier for the AWS service that corresponds to the service code defined in the call to <a>DescribeServices</a>.</li>\n <li>\n<b>SeverityCode. </b>The severity code assigned to the case. Contains one of the values returned by the call to <a>DescribeSeverityLevels</a>.</li>\n <li>\n<b>Status.</b> The status of the case in the AWS Support Center.</li>\n <li>\n<b>Subject.</b> The subject line of the case.</li>\n <li>\n<b>SubmittedBy.</b> The email address of the account that submitted the case.</li>\n <li>\n<b>TimeCreated.</b> The time the case was created, in ISO-8601 format.</li>\n </ol>\n \n "
|
||||
},
|
||||
"documentation": "\n <p>The details for the cases that match the request.</p> \n "
|
||||
},
|
||||
|
|
@ -396,7 +678,7 @@
|
|||
"documentation": "\n <p>The requested <code>CaseId</code> could not be located.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the <code>AfterTime</code> and <code>BeforeTime</code> request parameters. </p>\n \n <p>The response returns the following in JSON format:</p> \n <ol>\n <li>One or more <a>CaseDetails</a> data types. </li>\n <li>One or more <code>NextToken</code> values, which specify where to paginate the returned records represented by the <code>CaseDetails</code> objects.</li>\n </ol>\n ",
|
||||
"documentation": "\n <p>Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the <code>AfterTime</code> and <code>BeforeTime</code> request parameters. </p>\n <p>Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </p> \n <p>The response returns the following in JSON format:</p> \n <ol>\n <li>One or more <a>CaseDetails</a> data types. </li>\n <li>One or more <code>NextToken</code> values, which specify where to paginate the returned records represented by the <code>CaseDetails</code> objects.</li>\n </ol>\n ",
|
||||
"pagination": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
|
|
@ -420,12 +702,12 @@
|
|||
"beforeTime": {
|
||||
"shape_name": "BeforeTime",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The end date for a filtered date search on support case communications.</p>\n "
|
||||
"documentation": "\n <p>The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>\n "
|
||||
},
|
||||
"afterTime": {
|
||||
"shape_name": "AfterTime",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The start date for a filtered date search on support case communications.</p>\n "
|
||||
"documentation": "\n <p>The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>\n "
|
||||
},
|
||||
"nextToken": {
|
||||
"shape_name": "NextToken",
|
||||
|
|
@ -471,10 +753,32 @@
|
|||
"timeCreated": {
|
||||
"shape_name": "TimeCreated",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The time the support case was created. </p>\n "
|
||||
"documentation": "\n <p>The time the communication was created. </p>\n "
|
||||
},
|
||||
"attachmentSet": {
|
||||
"shape_name": "AttachmentSet",
|
||||
"type": "list",
|
||||
"members": {
|
||||
"shape_name": "AttachmentDetails",
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"attachmentId": {
|
||||
"shape_name": "AttachmentId",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The ID of the attachment.</p>\n"
|
||||
},
|
||||
"fileName": {
|
||||
"shape_name": "FileName",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The file name of the attachment.</p>\n"
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the <a>DescribeAttachment</a> operation.</p>\n"
|
||||
},
|
||||
"documentation": "\n <p>Information about the attachments to the case communication. </p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Exposes the fields used by a communication for an AWS Support case.</p>\n "
|
||||
"documentation": "\n <p>A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication.</p>\n "
|
||||
},
|
||||
"documentation": "\n <p>The communications for the case.</p>\n "
|
||||
},
|
||||
|
|
@ -484,7 +788,7 @@
|
|||
"documentation": "\n <p>A resumption point for pagination.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Contains the following objects or data if successful. Otherwise, returns an error.</p>\n "
|
||||
"documentation": "\n <p>The communications returned by the <a>DescribeCommunications</a> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
|
|
@ -512,7 +816,7 @@
|
|||
"documentation": "\n <p>The requested <code>CaseId</code> could not be located.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Returns communications regarding the support case. You can use the <code>AfterTime</code> and <code>BeforeTime</code> parameters to filter by date. The <code>CaseId</code> parameter enables you to identify a specific case by its <code>CaseId</code> value.</p>\n <p>The <code>MaxResults</code> and <code>NextToken</code> parameters enable you to control the pagination of the result set. Set <code>MaxResults</code> to the number of cases you want displayed on each page, and use <code>NextToken</code> to specify the resumption of pagination.</p>\n ",
|
||||
"documentation": "\n <p>Returns communications (and attachments) for one or more support cases. You can use the <code>AfterTime</code> and <code>BeforeTime</code> parameters to filter by date. You can use the <code>CaseId</code> parameter to restrict the results to a particular case.</p>\n <p>Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </p>\n <p>You can use the <code>MaxResults</code> and <code>NextToken</code> parameters to control the pagination of the result set. Set <code>MaxResults</code> to the number of cases you want displayed on each page, and use <code>NextToken</code> to specify the resumption of pagination.</p>\n ",
|
||||
"pagination": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
|
|
@ -562,12 +866,12 @@
|
|||
"code": {
|
||||
"shape_name": "ServiceCode",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The code for an AWS service returned by <a>DescribeServices</a> response. Has a corresponding name represented by Service.name.</p>\n "
|
||||
"documentation": "\n <p>The code for an AWS service returned by the <a>DescribeServices</a> response. The <code>Name</code> element contains the corresponding friendly name.</p>\n "
|
||||
},
|
||||
"name": {
|
||||
"shape_name": "ServiceName",
|
||||
"type": "string",
|
||||
"documentation": "\n <p>The friendly name for an AWS service. Has a corresponding code represented by Service.code. </p>\n "
|
||||
"documentation": "\n <p>The friendly name for an AWS service. The <code>Code</code> element contains the corresponding code.</p>\n "
|
||||
},
|
||||
"categories": {
|
||||
"shape_name": "CategoryList",
|
||||
|
|
@ -592,12 +896,12 @@
|
|||
"documentation": "\n <p>A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to AWS Support when you call <a>CreateCase</a>.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Represents an AWS Service returned by the <a>DescribeServices</a> action. </p>\n "
|
||||
"documentation": "\n <p>Information about an AWS service returned by the <a>DescribeServices</a> operation. </p>\n "
|
||||
},
|
||||
"documentation": "\n <p>A JSON-formatted list of AWS services.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Contains the following objects or data if successful. Otherwise, returns an error.</p>\n "
|
||||
"documentation": "\n <p>The list of AWS services returned by the <a>DescribeServices</a> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
|
|
@ -613,7 +917,7 @@
|
|||
"documentation": "\n <p>An internal server error occurred.</p>\n "
|
||||
}
|
||||
],
|
||||
"documentation": "\n <p>Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your <a>CreateCase</a> requests. Each AWS service has its own set of categories.</p>\n \n<p>The service codes and category codes correspond to the values that are displayed in the\n <b>Service</b> and <b>Category</b> drop-down lists on the AWS Support Center <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page. The values in those\n fields, however, do not necessarily match the service codes and categories returned by the\n <code>DescribeServices</code> request. Always use the service codes and categories obtained\n programmatically. This practice ensures that you always have the most recent set of service\n and category codes.</p> \n \n "
|
||||
"documentation": "\n <p>Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your <a>CreateCase</a> requests. Each AWS service has its own set of categories.</p>\n \n<p>The service codes and category codes correspond to the values that are displayed in the <b>Service</b> and <b>Category</b> drop-down lists on the AWS Support Center <a href=\"https://aws.amazon.com/support/createCase\">Open a new case</a> page. The values in those\n fields, however, do not necessarily match the service codes and categories returned by the\n <code>DescribeServices</code> request. Always use the service codes and categories obtained\n programmatically. This practice ensures that you always have the most recent set of service and category codes.</p> \n \n "
|
||||
},
|
||||
"DescribeSeverityLevels": {
|
||||
"name": "DescribeSeverityLevels",
|
||||
|
|
@ -656,7 +960,7 @@
|
|||
"documentation": "\n <p>The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Contains the following objects or data if successful. Otherwise, returns an error.</p>\n "
|
||||
"documentation": "\n <p>The list of severity levels returned by the <a>DescribeSeverityLevels</a> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
|
|
@ -730,7 +1034,7 @@
|
|||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Contains the following objects or data if successful. Otherwise, returns an error.</p>\n "
|
||||
"documentation": "\n <p>The statuses of the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorCheckRefreshStatuses</a> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
|
|
@ -891,7 +1195,7 @@
|
|||
"type": "string",
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "\n <p>Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the <a>TrustedAdvisorCheckDescription</a> object returned by the call to <a>DescribeTrustedAdvisorChecks</a>.</p>\n ",
|
||||
"documentation": "\n <p>Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the <a>TrustedAdvisorCheckDescription</a> object returned by the call to <a>DescribeTrustedAdvisorChecks</a>. <b>Metadata</b> contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data. </p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
|
|
@ -904,7 +1208,7 @@
|
|||
"documentation": "\n <p>The detailed results of the Trusted Advisor check.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Contains the following objects or data if successful. Otherwise, returns an error.</p>\n "
|
||||
"documentation": "\n <p>The result of the Trusted Advisor check returned by the <a>DescribeTrustedAdvisorCheckResult</a> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
|
|
@ -1042,7 +1346,7 @@
|
|||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Contains the following objects or data if successful. Otherwise, returns an error.</p>\n "
|
||||
"documentation": "\n <p>The summaries of the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorCheckSummaries</a> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
|
|
@ -1118,7 +1422,7 @@
|
|||
"type": "string",
|
||||
"documentation": null
|
||||
},
|
||||
"documentation": "\n <p>The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the <b>Metadata</b> element of the <a>TrustedAdvisorResourceDetail</a> for the check.</p>\n ",
|
||||
"documentation": "\n <p>The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the <b>Metadata</b> element of the <a>TrustedAdvisorResourceDetail</a> for the check. <b>Metadata</b> contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data. </p>\n ",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
|
|
@ -1128,7 +1432,7 @@
|
|||
"required": true
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Contains the following objects or data if successful. Otherwise, returns an error.</p>\n "
|
||||
"documentation": "\n <p>Information about the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorChecks</a> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
|
|
@ -1239,7 +1543,7 @@
|
|||
"documentation": "\n <p>The status of the case after the <a>ResolveCase</a> request was processed.</p>\n "
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Contains the following objects or data if successful. Otherwise, returns an error.</p>\n "
|
||||
"documentation": "\n <p>The status of the case returned by the <a>ResolveCase</a> operation.</p>\n "
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
|
|
|
|||
|
|
@ -7278,6 +7278,13 @@
|
|||
"input_token": "nextPageToken",
|
||||
"output_token": "nextPageToken",
|
||||
"result_key": "events",
|
||||
"non_aggregate_keys": [
|
||||
"taskToken",
|
||||
"startedEventId",
|
||||
"workflowExecution",
|
||||
"workflowType",
|
||||
"previousStartedEventId"
|
||||
],
|
||||
"py_input_token": "next_page_token"
|
||||
}
|
||||
},
|
||||
|
|
@ -8837,6 +8844,13 @@
|
|||
"input_token": "nextPageToken",
|
||||
"output_token": "nextPageToken",
|
||||
"result_key": "events",
|
||||
"non_aggregate_keys": [
|
||||
"taskToken",
|
||||
"startedEventId",
|
||||
"workflowExecution",
|
||||
"workflowType",
|
||||
"previousStartedEventId"
|
||||
],
|
||||
"py_input_token": "next_page_token"
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -30,6 +30,7 @@ from botocore.compat import urljoin, json, quote
|
|||
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
DEFAULT_TIMEOUT = 60
|
||||
|
||||
|
||||
class Endpoint(object):
|
||||
|
|
@ -44,7 +45,7 @@ class Endpoint(object):
|
|||
"""
|
||||
|
||||
def __init__(self, service, region_name, host, auth, proxies=None,
|
||||
verify=True):
|
||||
verify=True, timeout=DEFAULT_TIMEOUT):
|
||||
self.service = service
|
||||
self.session = self.service.session
|
||||
self.region_name = region_name
|
||||
|
|
@ -55,6 +56,7 @@ class Endpoint(object):
|
|||
proxies = {}
|
||||
self.proxies = proxies
|
||||
self.http_session = Session()
|
||||
self.timeout = timeout
|
||||
self._lock = threading.Lock()
|
||||
|
||||
def __repr__(self):
|
||||
|
|
@ -127,7 +129,7 @@ class Endpoint(object):
|
|||
http_response = self.http_session.send(
|
||||
request, verify=self.verify,
|
||||
stream=operation.is_streaming(),
|
||||
proxies=self.proxies)
|
||||
proxies=self.proxies, timeout=self.timeout)
|
||||
except Exception as e:
|
||||
logger.debug("Exception received when sending HTTP request.",
|
||||
exc_info=True)
|
||||
|
|
@ -267,7 +269,8 @@ def get_endpoint(service, region_name, endpoint_url, verify=None):
|
|||
service_style=service.type)
|
||||
service_name = getattr(service, 'signing_name', service.endpoint_prefix)
|
||||
auth = None
|
||||
if hasattr(service, 'signature_version'):
|
||||
if hasattr(service, 'signature_version') and \
|
||||
service.signature_version is not None:
|
||||
auth = _get_auth(service.signature_version,
|
||||
credentials=service.session.get_credentials(),
|
||||
service_name=service_name,
|
||||
|
|
|
|||
|
|
@ -61,7 +61,7 @@ class PartialCredentialsError(BotoCoreError):
|
|||
:ivar cred_var: The missing credential variable name.
|
||||
|
||||
"""
|
||||
fmt = 'Partial credentials found, missing: {cred_var}'
|
||||
fmt = 'Partial credentials found in {provider}, missing: {cred_var}'
|
||||
|
||||
|
||||
class NoRegionError(BotoCoreError):
|
||||
|
|
|
|||
|
|
@ -399,14 +399,14 @@ class ListParameter(Parameter):
|
|||
inner_xml = ''
|
||||
for item in value:
|
||||
xmlname = self.xmlname
|
||||
if not xmlname:
|
||||
if self.members.xmlname:
|
||||
xmlname = self.members.xmlname
|
||||
inner_xml += self.members.to_xml(item, xmlname)
|
||||
if self.flattened:
|
||||
return inner_xml
|
||||
else:
|
||||
if not label:
|
||||
label = self.xmlname
|
||||
label = self.xmlname or self.name
|
||||
return '<%s>' % label + inner_xml + '</%s>' % label
|
||||
|
||||
|
||||
|
|
@ -565,7 +565,7 @@ class StructParameter(Parameter):
|
|||
xml += '>'
|
||||
for member in self.members:
|
||||
if member.name in value and not hasattr(member, 'xmlattribute'):
|
||||
xml += member.to_xml(value[member.name], member.name)
|
||||
xml += member.to_xml(value[member.name], member.get_label())
|
||||
xml += '</%s>' % label
|
||||
return xml
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ import functools
|
|||
import logging
|
||||
from binascii import crc32
|
||||
|
||||
from botocore.vendored.requests import ConnectionError
|
||||
from botocore.vendored.requests import ConnectionError, Timeout
|
||||
from botocore.vendored.requests.packages.urllib3.exceptions import ClosedPoolError
|
||||
|
||||
from botocore.exceptions import ChecksumError
|
||||
|
|
@ -29,7 +29,7 @@ logger = logging.getLogger(__name__)
|
|||
# to get more specific exceptions from requests we can update
|
||||
# this mapping with more specific exceptions.
|
||||
EXCEPTION_MAP = {
|
||||
'GENERAL_CONNECTION_ERROR': [ConnectionError, ClosedPoolError],
|
||||
'GENERAL_CONNECTION_ERROR': [ConnectionError, ClosedPoolError, Timeout],
|
||||
}
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ from copy import deepcopy
|
|||
import jmespath
|
||||
|
||||
from botocore.compat import OrderedDict, json
|
||||
from botocore.utils import set_value_from_jmespath, merge_dicts
|
||||
from botocore.utils import merge_dicts
|
||||
from botocore import xform_name
|
||||
|
||||
|
||||
|
|
@ -79,9 +79,11 @@ def translate(model):
|
|||
new_model,
|
||||
model.enhancements.get('waiters', {}))
|
||||
# Merge in any per operation overrides defined in the .extras.json file.
|
||||
merge_dicts(new_model['operations'], model.enhancements.get('operations', {}))
|
||||
merge_dicts(new_model['operations'],
|
||||
model.enhancements.get('operations', {}))
|
||||
add_retry_configs(
|
||||
new_model, model.retry.get('retry', {}), definitions=model.retry.get('definitions', {}))
|
||||
new_model, model.retry.get('retry', {}),
|
||||
definitions=model.retry.get('definitions', {}))
|
||||
return new_model
|
||||
|
||||
|
||||
|
|
@ -160,13 +162,13 @@ def _filter_param_doc(param, replacement, regex):
|
|||
|
||||
|
||||
def handle_filter_documentation(new_model, enhancements):
|
||||
#This provides a way to filter undesireable content (e.g. CDATA)
|
||||
#from documentation strings
|
||||
filter = enhancements.get('transformations', {}).get(
|
||||
# This provides a way to filter undesireable content (e.g. CDATA)
|
||||
# from documentation strings.
|
||||
doc_filter = enhancements.get('transformations', {}).get(
|
||||
'filter-documentation', {}).get('filter')
|
||||
if filter is not None:
|
||||
filter_regex = re.compile(filter.get('regex', ''), re.DOTALL)
|
||||
replacement = filter.get('replacement')
|
||||
if doc_filter is not None:
|
||||
filter_regex = re.compile(doc_filter.get('regex', ''), re.DOTALL)
|
||||
replacement = doc_filter.get('replacement')
|
||||
operations = new_model['operations']
|
||||
for op_name in operations:
|
||||
operation = operations[op_name]
|
||||
|
|
@ -200,9 +202,8 @@ def handle_rename_params(new_model, enhancements):
|
|||
|
||||
def resembles_jmespath_exp(value):
|
||||
# For now, we'll do a naive check.
|
||||
if '.' in value:
|
||||
if '.' in value or '[' in value:
|
||||
return True
|
||||
|
||||
return False
|
||||
|
||||
|
||||
|
|
@ -218,44 +219,47 @@ def add_pagination_configs(new_model, pagination):
|
|||
config = pagination[name]
|
||||
_check_known_pagination_keys(config)
|
||||
if 'py_input_token' not in config:
|
||||
input_token = config['input_token']
|
||||
if isinstance(input_token, list):
|
||||
py_input_token = []
|
||||
for token in input_token:
|
||||
py_input_token.append(xform_name(token))
|
||||
config['py_input_token'] = py_input_token
|
||||
else:
|
||||
config['py_input_token'] = xform_name(input_token)
|
||||
# result_key must be defined
|
||||
if 'result_key' not in config:
|
||||
raise ValueError("Required key 'result_key' is missing from "
|
||||
"from pagination config: %s" % config)
|
||||
if name not in new_model['operations']:
|
||||
raise ValueError("Trying to add pagination config for non "
|
||||
"existent operation: %s" % name)
|
||||
operation = new_model['operations'].get(name)
|
||||
# result_key must match a key in the output.
|
||||
if not isinstance(config['result_key'], list):
|
||||
result_keys = [config['result_key']]
|
||||
else:
|
||||
result_keys = config['result_key']
|
||||
if result_keys and not operation['output']:
|
||||
raise ValueError("Trying to add pagination config for an "
|
||||
"operation with no output members: %s" % name)
|
||||
for result_key in result_keys:
|
||||
if resembles_jmespath_exp(result_key):
|
||||
continue
|
||||
if result_key not in operation['output']['members']:
|
||||
raise ValueError("result_key %r is not an output member: %s" %
|
||||
(result_key,
|
||||
operation['output']['members'].keys()))
|
||||
_add_py_input_token(config)
|
||||
_validate_result_key_exists(config)
|
||||
_validate_referenced_operation_exists(new_model, name)
|
||||
operation = new_model['operations'][name]
|
||||
_validate_operation_has_output(operation, name)
|
||||
_check_input_keys_match(config, operation)
|
||||
if operation is None:
|
||||
raise ValueError("Tried to add a pagination config for non "
|
||||
"existent operation '%s'" % name)
|
||||
_check_output_keys_match(config, operation,
|
||||
new_model.get('endpoint_prefix', ''))
|
||||
operation['pagination'] = config.copy()
|
||||
|
||||
|
||||
def _validate_operation_has_output(operation, name):
|
||||
if not operation['output']:
|
||||
raise ValueError("Trying to add pagination config for an "
|
||||
"operation with no output members: %s" % name)
|
||||
|
||||
|
||||
def _validate_referenced_operation_exists(new_model, name):
|
||||
if name not in new_model['operations']:
|
||||
raise ValueError("Trying to add pagination config for non "
|
||||
"existent operation: %s" % name)
|
||||
|
||||
|
||||
def _validate_result_key_exists(config):
|
||||
# result_key must be defined.
|
||||
if 'result_key' not in config:
|
||||
raise ValueError("Required key 'result_key' is missing from "
|
||||
"from pagination config: %s" % config)
|
||||
|
||||
|
||||
def _add_py_input_token(config):
|
||||
input_token = config['input_token']
|
||||
if isinstance(input_token, list):
|
||||
py_input_token = []
|
||||
for token in input_token:
|
||||
py_input_token.append(xform_name(token))
|
||||
config['py_input_token'] = py_input_token
|
||||
else:
|
||||
config['py_input_token'] = xform_name(input_token)
|
||||
|
||||
|
||||
def add_waiter_configs(new_model, waiters):
|
||||
if waiters:
|
||||
denormalized = denormalize_waiters(waiters)
|
||||
|
|
@ -335,18 +339,18 @@ def denormalize_single_waiter(value, default, waiters):
|
|||
# want to completely remove the acceptor types.
|
||||
# The logic here is that if there is no success/failure_* variable
|
||||
# defined, it inherits this value from the matching acceptor_* variable.
|
||||
new_waiter['success_type'] = new_waiter.get('success_type',
|
||||
new_waiter.get('acceptor_type'))
|
||||
new_waiter['success_path'] = new_waiter.get('success_path',
|
||||
new_waiter.get('acceptor_path'))
|
||||
new_waiter['success_value'] = new_waiter.get('success_value',
|
||||
new_waiter.get('acceptor_value'))
|
||||
new_waiter['failure_type'] = new_waiter.get('failure_type',
|
||||
new_waiter.get('acceptor_type'))
|
||||
new_waiter['failure_path'] = new_waiter.get('failure_path',
|
||||
new_waiter.get('acceptor_path'))
|
||||
new_waiter['failure_value'] = new_waiter.get('failure_value',
|
||||
new_waiter.get('acceptor_value'))
|
||||
new_waiter['success_type'] = new_waiter.get(
|
||||
'success_type', new_waiter.get('acceptor_type'))
|
||||
new_waiter['success_path'] = new_waiter.get(
|
||||
'success_path', new_waiter.get('acceptor_path'))
|
||||
new_waiter['success_value'] = new_waiter.get(
|
||||
'success_value', new_waiter.get('acceptor_value'))
|
||||
new_waiter['failure_type'] = new_waiter.get(
|
||||
'failure_type', new_waiter.get('acceptor_type'))
|
||||
new_waiter['failure_path'] = new_waiter.get(
|
||||
'failure_path', new_waiter.get('acceptor_path'))
|
||||
new_waiter['failure_value'] = new_waiter.get(
|
||||
'failure_value', new_waiter.get('acceptor_value'))
|
||||
# We can remove acceptor_* vars because they're only used for lookups
|
||||
# and we've already performed this step in the lines above.
|
||||
new_waiter.pop('acceptor_type', '')
|
||||
|
|
@ -360,11 +364,11 @@ def denormalize_single_waiter(value, default, waiters):
|
|||
for required in ['operation', 'success_type']:
|
||||
if required not in new_waiter:
|
||||
raise ValueError('Missing required waiter configuration '
|
||||
'value "%s": %s' % (required, new_waiter))
|
||||
'value "%s": %s' % (required, new_waiter))
|
||||
if new_waiter.get(required) is None:
|
||||
raise ValueError('Required waiter configuration '
|
||||
'value cannot be None "%s": %s'
|
||||
% (required, new_waiter))
|
||||
'value cannot be None "%s": %s' %
|
||||
(required, new_waiter))
|
||||
# Finally, success/failure values can be a scalar or a list. We're going
|
||||
# to just always make them a list.
|
||||
if 'success_value' in new_waiter and not \
|
||||
|
|
@ -406,6 +410,57 @@ def _check_known_pagination_keys(config):
|
|||
raise ValueError("Unknown key in pagination config: %s" % key)
|
||||
|
||||
|
||||
def _check_output_keys_match(config, operation, service_name):
|
||||
output_members = list(operation['output']['members'])
|
||||
jmespath_seen = False
|
||||
for output_key in _get_all_page_output_keys(config):
|
||||
if resembles_jmespath_exp(output_key):
|
||||
# We don't validate jmespath expressions for now.
|
||||
jmespath_seen = True
|
||||
continue
|
||||
if output_key not in output_members:
|
||||
raise ValueError("Key %r is not an output member: %s" %
|
||||
(output_key,
|
||||
output_members))
|
||||
output_members.remove(output_key)
|
||||
# Some services echo the input parameters in the response
|
||||
# output. We should not trigger a validation error
|
||||
# if those params are still not accounted for.
|
||||
for input_name in operation['input']['members']:
|
||||
if input_name in output_members:
|
||||
output_members.remove(input_name)
|
||||
if not jmespath_seen and output_members:
|
||||
# Because we can't validate jmespath expressions yet,
|
||||
# we can't say for user if output_members actually has
|
||||
# remaining keys or not.
|
||||
if service_name == 's3' and output_members == ['Name']:
|
||||
# The S3 model uses 'Name' for the output key, which
|
||||
# actually maps to the 'Bucket' input param so we don't
|
||||
# need to validate this output member. This is the only
|
||||
# model that has this, so we can just special case this
|
||||
# for now.
|
||||
return
|
||||
raise ValueError("Output members still exist for operation %s: %s" % (
|
||||
operation['name'], output_members))
|
||||
|
||||
|
||||
def _get_all_page_output_keys(config):
|
||||
if not isinstance(config['result_key'], list):
|
||||
yield config['result_key']
|
||||
else:
|
||||
for result_key in config['result_key']:
|
||||
yield result_key
|
||||
if not isinstance(config['output_token'], list):
|
||||
yield config['output_token']
|
||||
else:
|
||||
for result_key in config['output_token']:
|
||||
yield result_key
|
||||
if 'more_results' in config:
|
||||
yield config['more_results']
|
||||
for key in config.get('non_aggregate_keys', []):
|
||||
yield key
|
||||
|
||||
|
||||
def _check_input_keys_match(config, operation):
|
||||
input_tokens = config['input_token']
|
||||
if not isinstance(input_tokens, list):
|
||||
|
|
|
|||
|
|
@ -12,10 +12,11 @@
|
|||
# language governing permissions and limitations under the License.
|
||||
import logging
|
||||
|
||||
from six import string_types, text_type
|
||||
|
||||
from .exceptions import InvalidExpressionError, ConfigNotFound
|
||||
from .compat import json
|
||||
from .vendored import requests
|
||||
from botocore.exceptions import InvalidExpressionError, ConfigNotFound
|
||||
from botocore.compat import json, quote
|
||||
from botocore.vendored import requests
|
||||
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
|
@ -23,6 +24,9 @@ DEFAULT_METADATA_SERVICE_TIMEOUT = 1
|
|||
METADATA_SECURITY_CREDENTIALS_URL = (
|
||||
'http://169.254.169.254/latest/meta-data/iam/security-credentials/'
|
||||
)
|
||||
# These are chars that do not need to be urlencoded.
|
||||
# Based on rfc2986, section 2.3
|
||||
SAFE_CHARS = '-._~'
|
||||
|
||||
|
||||
class _RetriesExceededError(Exception):
|
||||
|
|
@ -223,3 +227,43 @@ def parse_key_val_file_contents(contents):
|
|||
val = val.strip()
|
||||
final[key] = val
|
||||
return final
|
||||
|
||||
|
||||
def percent_encode_sequence(mapping, safe=SAFE_CHARS):
|
||||
"""Urlencode a dict or list into a string.
|
||||
|
||||
This is similar to urllib.urlencode except that:
|
||||
|
||||
* It uses quote, and not quote_plus
|
||||
* It has a default list of safe chars that don't need
|
||||
to be encoded, which matches what AWS services expect.
|
||||
|
||||
This function should be preferred over the stdlib
|
||||
``urlencode()`` function.
|
||||
|
||||
:param mapping: Either a dict to urlencode or a list of
|
||||
``(key, value)`` pairs.
|
||||
|
||||
"""
|
||||
encoded_pairs = []
|
||||
if hasattr(mapping, 'items'):
|
||||
pairs = mapping.items()
|
||||
else:
|
||||
pairs = mapping
|
||||
for key, value in pairs:
|
||||
encoded_pairs.append('%s=%s' % (percent_encode(key),
|
||||
percent_encode(value)))
|
||||
return '&'.join(encoded_pairs)
|
||||
|
||||
|
||||
def percent_encode(input_str, safe=SAFE_CHARS):
|
||||
"""Urlencodes a string.
|
||||
|
||||
Whereas percent_encode_sequence handles taking a dict/sequence and
|
||||
producing a percent encoded string, this function deals only with
|
||||
taking a string (not a dict/sequence) and percent encoding it.
|
||||
|
||||
"""
|
||||
if not isinstance(input_str, string_types):
|
||||
input_str = text_type(input_str)
|
||||
return quote(text_type(input_str), safe=safe)
|
||||
|
|
|
|||
7
debian/changelog
vendored
7
debian/changelog
vendored
|
|
@ -1,3 +1,10 @@
|
|||
python-botocore (0.62.0-1) unstable; urgency=medium
|
||||
|
||||
* New upstream release
|
||||
* debian/patches: refresh
|
||||
|
||||
-- TANIGUCHI Takaki <takaki@debian.org> Thu, 04 Sep 2014 11:59:09 +0900
|
||||
|
||||
python-botocore (0.55.0-1) unstable; urgency=medium
|
||||
|
||||
* New upstream release
|
||||
|
|
|
|||
36
debian/patches/remove-duplicated-code
vendored
36
debian/patches/remove-duplicated-code
vendored
|
|
@ -20,10 +20,10 @@ Forwarded: <no|not-needed|url proving that it has been forwarded>
|
|||
Reviewed-By: <name and email of someone who approved the patch>
|
||||
Last-Update: <YYYY-MM-DD>
|
||||
|
||||
Index: python-botocore-0.52.0/botocore/endpoint.py
|
||||
Index: python-botocore-0.62.0/botocore/endpoint.py
|
||||
===================================================================
|
||||
--- python-botocore-0.52.0.orig/botocore/endpoint.py 2014-06-22 19:12:55.888338509 +0900
|
||||
+++ python-botocore-0.52.0/botocore/endpoint.py 2014-06-22 19:12:55.884338571 +0900
|
||||
--- python-botocore-0.62.0.orig/botocore/endpoint.py 2014-09-04 11:53:11.603921152 +0900
|
||||
+++ python-botocore-0.62.0/botocore/endpoint.py 2014-09-04 11:53:11.583921657 +0900
|
||||
@@ -17,8 +17,8 @@
|
||||
import time
|
||||
import threading
|
||||
|
|
@ -35,25 +35,25 @@ Index: python-botocore-0.52.0/botocore/endpoint.py
|
|||
import six
|
||||
|
||||
import botocore.response
|
||||
Index: python-botocore-0.52.0/botocore/retryhandler.py
|
||||
Index: python-botocore-0.62.0/botocore/retryhandler.py
|
||||
===================================================================
|
||||
--- python-botocore-0.52.0.orig/botocore/retryhandler.py 2014-06-22 19:12:55.888338509 +0900
|
||||
+++ python-botocore-0.52.0/botocore/retryhandler.py 2014-06-22 19:12:55.884338571 +0900
|
||||
--- python-botocore-0.62.0.orig/botocore/retryhandler.py 2014-09-04 11:53:11.603921152 +0900
|
||||
+++ python-botocore-0.62.0/botocore/retryhandler.py 2014-09-04 11:55:06.209047860 +0900
|
||||
@@ -17,8 +17,8 @@
|
||||
import logging
|
||||
from binascii import crc32
|
||||
|
||||
-from botocore.vendored.requests import ConnectionError
|
||||
-from botocore.vendored.requests import ConnectionError, Timeout
|
||||
-from botocore.vendored.requests.packages.urllib3.exceptions import ClosedPoolError
|
||||
+from requests import ConnectionError
|
||||
+from requests import ConnectionError, Timeout
|
||||
+from urllib3.exceptions import ClosedPoolError
|
||||
|
||||
from botocore.exceptions import ChecksumError
|
||||
|
||||
Index: python-botocore-0.52.0/botocore/awsrequest.py
|
||||
Index: python-botocore-0.62.0/botocore/awsrequest.py
|
||||
===================================================================
|
||||
--- python-botocore-0.52.0.orig/botocore/awsrequest.py 2014-06-22 19:12:55.888338509 +0900
|
||||
+++ python-botocore-0.52.0/botocore/awsrequest.py 2014-06-22 19:13:52.571480844 +0900
|
||||
--- python-botocore-0.62.0.orig/botocore/awsrequest.py 2014-09-04 11:53:11.603921152 +0900
|
||||
+++ python-botocore-0.62.0/botocore/awsrequest.py 2014-09-04 11:53:11.587921553 +0900
|
||||
@@ -17,14 +17,14 @@
|
||||
import inspect
|
||||
|
||||
|
|
@ -75,15 +75,15 @@ Index: python-botocore-0.52.0/botocore/awsrequest.py
|
|||
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
Index: python-botocore-0.52.0/botocore/utils.py
|
||||
Index: python-botocore-0.62.0/botocore/utils.py
|
||||
===================================================================
|
||||
--- python-botocore-0.52.0.orig/botocore/utils.py 2014-06-20 06:28:15.000000000 +0900
|
||||
+++ python-botocore-0.52.0/botocore/utils.py 2014-06-22 19:15:44.709784035 +0900
|
||||
@@ -15,7 +15,7 @@
|
||||
--- python-botocore-0.62.0.orig/botocore/utils.py 2014-09-04 11:53:11.603921152 +0900
|
||||
+++ python-botocore-0.62.0/botocore/utils.py 2014-09-04 11:54:04.814583384 +0900
|
||||
@@ -16,7 +16,7 @@
|
||||
|
||||
from .exceptions import InvalidExpressionError, ConfigNotFound
|
||||
from .compat import json
|
||||
-from .vendored import requests
|
||||
from botocore.exceptions import InvalidExpressionError, ConfigNotFound
|
||||
from botocore.compat import json, quote
|
||||
-from botocore.vendored import requests
|
||||
+import requests
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue