')
- if version != 1:
- raise CredentialRetrievalError(
- provider=self.METHOD,
- error_msg=("Unsupported version '%s' for credential process "
- "provider, supported versions: 1" % version))
- try:
- return {
- 'access_key': parsed['AccessKeyId'],
- 'secret_key': parsed['SecretAccessKey'],
- 'token': parsed.get('SessionToken'),
- 'expiry_time': parsed.get('Expiration'),
- }
- except KeyError as e:
- raise CredentialRetrievalError(
- provider=self.METHOD,
- error_msg="Missing required key in response: %s" % e
- )
-
- @property
- def _credential_process(self):
- if self._loaded_config is None:
- self._loaded_config = self._load_config()
- profile_config = self._loaded_config.get(
- 'profiles', {}).get(self._profile_name, {})
- return profile_config.get('credential_process')
-
-
-class InstanceMetadataProvider(CredentialProvider):
- METHOD = 'iam-role'
- CANONICAL_NAME = 'Ec2InstanceMetadata'
-
- def __init__(self, iam_role_fetcher):
- self._role_fetcher = iam_role_fetcher
-
- def load(self):
- fetcher = self._role_fetcher
- # We do the first request, to see if we get useful data back.
- # If not, we'll pass & move on to whatever's next in the credential
- # chain.
- metadata = fetcher.retrieve_iam_role_credentials()
- if not metadata:
- return None
- logger.debug('Found credentials from IAM Role: %s',
- metadata['role_name'])
- # We manually set the data here, since we already made the request &
- # have it. When the expiry is hit, the credentials will auto-refresh
- # themselves.
- creds = RefreshableCredentials.create_from_metadata(
- metadata,
- method=self.METHOD,
- refresh_using=fetcher.retrieve_iam_role_credentials,
- )
- return creds
-
-
-class EnvProvider(CredentialProvider):
- METHOD = 'env'
- CANONICAL_NAME = 'Environment'
- ACCESS_KEY = 'AWS_ACCESS_KEY_ID'
- SECRET_KEY = 'AWS_SECRET_ACCESS_KEY'
- # The token can come from either of these env var.
- # AWS_SESSION_TOKEN is what other AWS SDKs have standardized on.
- TOKENS = ['AWS_SECURITY_TOKEN', 'AWS_SESSION_TOKEN']
- EXPIRY_TIME = 'AWS_CREDENTIAL_EXPIRATION'
-
- def __init__(self, environ=None, mapping=None):
- """
-
- :param environ: The environment variables (defaults to
- ``os.environ`` if no value is provided).
- :param mapping: An optional mapping of variable names to
- environment variable names. Use this if you want to
- change the mapping of access_key->AWS_ACCESS_KEY_ID, etc.
- The dict can have up to 3 keys: ``access_key``, ``secret_key``,
- ``session_token``.
- """
- if environ is None:
- environ = os.environ
- self.environ = environ
- self._mapping = self._build_mapping(mapping)
-
- def _build_mapping(self, mapping):
- # Mapping of variable name to env var name.
- var_mapping = {}
- if mapping is None:
- # Use the class var default.
- var_mapping['access_key'] = self.ACCESS_KEY
- var_mapping['secret_key'] = self.SECRET_KEY
- var_mapping['token'] = self.TOKENS
- var_mapping['expiry_time'] = self.EXPIRY_TIME
- else:
- var_mapping['access_key'] = mapping.get(
- 'access_key', self.ACCESS_KEY)
- var_mapping['secret_key'] = mapping.get(
- 'secret_key', self.SECRET_KEY)
- var_mapping['token'] = mapping.get(
- 'token', self.TOKENS)
- if not isinstance(var_mapping['token'], list):
- var_mapping['token'] = [var_mapping['token']]
- var_mapping['expiry_time'] = mapping.get(
- 'expiry_time', self.EXPIRY_TIME)
- return var_mapping
-
- def load(self):
- """
- Search for credentials in explicit environment variables.
- """
- if self._mapping['access_key'] in self.environ:
- logger.info('Found credentials in environment variables.')
- fetcher = self._create_credentials_fetcher()
- credentials = fetcher(require_expiry=False)
-
- expiry_time = credentials['expiry_time']
- if expiry_time is not None:
- expiry_time = parse(expiry_time)
- return RefreshableCredentials(
- credentials['access_key'], credentials['secret_key'],
- credentials['token'], expiry_time,
- refresh_using=fetcher, method=self.METHOD
- )
-
- return Credentials(
- credentials['access_key'], credentials['secret_key'],
- credentials['token'], method=self.METHOD
- )
- else:
- return None
-
- def _create_credentials_fetcher(self):
- mapping = self._mapping
- method = self.METHOD
- environ = self.environ
-
- def fetch_credentials(require_expiry=True):
- credentials = {}
-
- access_key = environ.get(mapping['access_key'])
- if access_key is None:
- raise PartialCredentialsError(
- provider=method, cred_var=mapping['access_key'])
- credentials['access_key'] = access_key
-
- secret_key = environ.get(mapping['secret_key'])
- if secret_key is None:
- raise PartialCredentialsError(
- provider=method, cred_var=mapping['secret_key'])
- credentials['secret_key'] = secret_key
-
- token = None
- for token_env_var in mapping['token']:
- if token_env_var in environ:
- token = environ[token_env_var]
- break
- credentials['token'] = token
-
- expiry_time = environ.get(mapping['expiry_time'])
- if require_expiry and expiry_time is None:
- raise PartialCredentialsError(
- provider=method, cred_var=mapping['expiry_time'])
- credentials['expiry_time'] = expiry_time
-
- return credentials
-
- return fetch_credentials
-
-
-class OriginalEC2Provider(CredentialProvider):
- METHOD = 'ec2-credentials-file'
- CANONICAL_NAME = 'Ec2Config'
-
- CRED_FILE_ENV = 'AWS_CREDENTIAL_FILE'
- ACCESS_KEY = 'AWSAccessKeyId'
- SECRET_KEY = 'AWSSecretKey'
-
- def __init__(self, environ=None, parser=None):
- if environ is None:
- environ = os.environ
- if parser is None:
- parser = parse_key_val_file
- self._environ = environ
- self._parser = parser
-
- def load(self):
- """
- Search for a credential file used by original EC2 CLI tools.
- """
- if 'AWS_CREDENTIAL_FILE' in self._environ:
- full_path = os.path.expanduser(
- self._environ['AWS_CREDENTIAL_FILE'])
- creds = self._parser(full_path)
- if self.ACCESS_KEY in creds:
- logger.info('Found credentials in AWS_CREDENTIAL_FILE.')
- access_key = creds[self.ACCESS_KEY]
- secret_key = creds[self.SECRET_KEY]
- # EC2 creds file doesn't support session tokens.
- return Credentials(access_key, secret_key, method=self.METHOD)
- else:
- return None
-
-
-class SharedCredentialProvider(CredentialProvider):
- METHOD = 'shared-credentials-file'
- CANONICAL_NAME = 'SharedCredentials'
-
- ACCESS_KEY = 'aws_access_key_id'
- SECRET_KEY = 'aws_secret_access_key'
- # Same deal as the EnvProvider above. Botocore originally supported
- # aws_security_token, but the SDKs are standardizing on aws_session_token
- # so we support both.
- TOKENS = ['aws_security_token', 'aws_session_token']
-
- def __init__(self, creds_filename, profile_name=None, ini_parser=None):
- self._creds_filename = creds_filename
- if profile_name is None:
- profile_name = 'default'
- self._profile_name = profile_name
- if ini_parser is None:
- ini_parser = botocore.configloader.raw_config_parse
- self._ini_parser = ini_parser
-
- def load(self):
- try:
- available_creds = self._ini_parser(self._creds_filename)
- except ConfigNotFound:
- return None
- if self._profile_name in available_creds:
- config = available_creds[self._profile_name]
- if self.ACCESS_KEY in config:
- logger.info("Found credentials in shared credentials file: %s",
- self._creds_filename)
- access_key, secret_key = self._extract_creds_from_mapping(
- config, self.ACCESS_KEY, self.SECRET_KEY)
- token = self._get_session_token(config)
- return Credentials(access_key, secret_key, token,
- method=self.METHOD)
-
- def _get_session_token(self, config):
- for token_envvar in self.TOKENS:
- if token_envvar in config:
- return config[token_envvar]
-
-
-class ConfigProvider(CredentialProvider):
- """INI based config provider with profile sections."""
- METHOD = 'config-file'
- CANONICAL_NAME = 'SharedConfig'
-
- ACCESS_KEY = 'aws_access_key_id'
- SECRET_KEY = 'aws_secret_access_key'
- # Same deal as the EnvProvider above. Botocore originally supported
- # aws_security_token, but the SDKs are standardizing on aws_session_token
- # so we support both.
- TOKENS = ['aws_security_token', 'aws_session_token']
-
- def __init__(self, config_filename, profile_name, config_parser=None):
- """
-
- :param config_filename: The session configuration scoped to the current
- profile. This is available via ``session.config``.
- :param profile_name: The name of the current profile.
- :param config_parser: A config parser callable.
-
- """
- self._config_filename = config_filename
- self._profile_name = profile_name
- if config_parser is None:
- config_parser = botocore.configloader.load_config
- self._config_parser = config_parser
-
- def load(self):
- """
- If there is are credentials in the configuration associated with
- the session, use those.
- """
- try:
- full_config = self._config_parser(self._config_filename)
- except ConfigNotFound:
- return None
- if self._profile_name in full_config['profiles']:
- profile_config = full_config['profiles'][self._profile_name]
- if self.ACCESS_KEY in profile_config:
- logger.info("Credentials found in config file: %s",
- self._config_filename)
- access_key, secret_key = self._extract_creds_from_mapping(
- profile_config, self.ACCESS_KEY, self.SECRET_KEY)
- token = self._get_session_token(profile_config)
- return Credentials(access_key, secret_key, token,
- method=self.METHOD)
- else:
- return None
-
- def _get_session_token(self, profile_config):
- for token_name in self.TOKENS:
- if token_name in profile_config:
- return profile_config[token_name]
-
-
-class BotoProvider(CredentialProvider):
- METHOD = 'boto-config'
- CANONICAL_NAME = 'Boto2Config'
-
- BOTO_CONFIG_ENV = 'BOTO_CONFIG'
- DEFAULT_CONFIG_FILENAMES = ['/etc/boto.cfg', '~/.boto']
- ACCESS_KEY = 'aws_access_key_id'
- SECRET_KEY = 'aws_secret_access_key'
-
- def __init__(self, environ=None, ini_parser=None):
- if environ is None:
- environ = os.environ
- if ini_parser is None:
- ini_parser = botocore.configloader.raw_config_parse
- self._environ = environ
- self._ini_parser = ini_parser
-
- def load(self):
- """
- Look for credentials in boto config file.
- """
- if self.BOTO_CONFIG_ENV in self._environ:
- potential_locations = [self._environ[self.BOTO_CONFIG_ENV]]
- else:
- potential_locations = self.DEFAULT_CONFIG_FILENAMES
- for filename in potential_locations:
- try:
- config = self._ini_parser(filename)
- except ConfigNotFound:
- # Move on to the next potential config file name.
- continue
- if 'Credentials' in config:
- credentials = config['Credentials']
- if self.ACCESS_KEY in credentials:
- logger.info("Found credentials in boto config file: %s",
- filename)
- access_key, secret_key = self._extract_creds_from_mapping(
- credentials, self.ACCESS_KEY, self.SECRET_KEY)
- return Credentials(access_key, secret_key,
- method=self.METHOD)
-
-
-class AssumeRoleProvider(CredentialProvider):
- METHOD = 'assume-role'
- # The AssumeRole provider is logically part of the SharedConfig and
- # SharedCredentials providers. Since the purpose of the canonical name
- # is to provide cross-sdk compatibility, calling code will need to be
- # aware that either of those providers should be tied to the AssumeRole
- # provider as much as possible.
- CANONICAL_NAME = None
- ROLE_CONFIG_VAR = 'role_arn'
- # Credentials are considered expired (and will be refreshed) once the total
- # remaining time left until the credentials expires is less than the
- # EXPIRY_WINDOW.
- EXPIRY_WINDOW_SECONDS = 60 * 15
-
- def __init__(self, load_config, client_creator, cache, profile_name,
- prompter=getpass.getpass, credential_sourcer=None):
- """
- :type load_config: callable
- :param load_config: A function that accepts no arguments, and
- when called, will return the full configuration dictionary
- for the session (``session.full_config``).
-
- :type client_creator: callable
- :param client_creator: A factory function that will create
- a client when called. Has the same interface as
- ``botocore.session.Session.create_client``.
-
- :type cache: dict
- :param cache: An object that supports ``__getitem__``,
- ``__setitem__``, and ``__contains__``. An example
- of this is the ``JSONFileCache`` class in the CLI.
-
- :type profile_name: str
- :param profile_name: The name of the profile.
-
- :type prompter: callable
- :param prompter: A callable that returns input provided
- by the user (i.e raw_input, getpass.getpass, etc.).
-
- :type credential_sourcer: CanonicalNameCredentialSourcer
- :param credential_sourcer: A credential provider that takes a
- configuration, which is used to provide the source credentials
- for the STS call.
- """
- #: The cache used to first check for assumed credentials.
- #: This is checked before making the AssumeRole API
- #: calls and can be useful if you have short lived
- #: scripts and you'd like to avoid calling AssumeRole
- #: until the credentials are expired.
- self.cache = cache
- self._load_config = load_config
- # client_creator is a callable that creates function.
- # It's basically session.create_client
- self._client_creator = client_creator
- self._profile_name = profile_name
- self._prompter = prompter
- # The _loaded_config attribute will be populated from the
- # load_config() function once the configuration is actually
- # loaded. The reason we go through all this instead of just
- # requiring that the loaded_config be passed to us is to that
- # we can defer configuration loaded until we actually try
- # to load credentials (as opposed to when the object is
- # instantiated).
- self._loaded_config = {}
- self._credential_sourcer = credential_sourcer
- self._visited_profiles = [self._profile_name]
-
- def load(self):
- self._loaded_config = self._load_config()
- profiles = self._loaded_config.get('profiles', {})
- profile = profiles.get(self._profile_name, {})
- if self._has_assume_role_config_vars(profile):
- return self._load_creds_via_assume_role(self._profile_name)
-
- def _has_assume_role_config_vars(self, profile):
- return self.ROLE_CONFIG_VAR in profile
-
- def _load_creds_via_assume_role(self, profile_name):
- role_config = self._get_role_config(profile_name)
- source_credentials = self._resolve_source_credentials(
- role_config, profile_name
- )
-
- extra_args = {}
- role_session_name = role_config.get('role_session_name')
- if role_session_name is not None:
- extra_args['RoleSessionName'] = role_session_name
-
- external_id = role_config.get('external_id')
- if external_id is not None:
- extra_args['ExternalId'] = external_id
-
- mfa_serial = role_config.get('mfa_serial')
- if mfa_serial is not None:
- extra_args['SerialNumber'] = mfa_serial
-
- fetcher = AssumeRoleCredentialFetcher(
- client_creator=self._client_creator,
- source_credentials=source_credentials,
- role_arn=role_config['role_arn'],
- extra_args=extra_args,
- mfa_prompter=self._prompter,
- cache=self.cache,
- )
- refresher = fetcher.fetch_credentials
- if mfa_serial is not None:
- refresher = create_mfa_serial_refresher(refresher)
-
- # The initial credentials are empty and the expiration time is set
- # to now so that we can delay the call to assume role until it is
- # strictly needed.
- return DeferredRefreshableCredentials(
- method=self.METHOD,
- refresh_using=refresher,
- time_fetcher=_local_now
- )
-
- def _get_role_config(self, profile_name):
- """Retrieves and validates the role configuration for the profile."""
- profiles = self._loaded_config.get('profiles', {})
-
- profile = profiles[profile_name]
- source_profile = profile.get('source_profile')
- role_arn = profile['role_arn']
- credential_source = profile.get('credential_source')
- mfa_serial = profile.get('mfa_serial')
- external_id = profile.get('external_id')
- role_session_name = profile.get('role_session_name')
-
- role_config = {
- 'role_arn': role_arn,
- 'external_id': external_id,
- 'mfa_serial': mfa_serial,
- 'role_session_name': role_session_name,
- 'source_profile': source_profile,
- 'credential_source': credential_source
- }
-
- # Either the credential source or the source profile must be
- # specified, but not both.
- if credential_source is not None and source_profile is not None:
- raise InvalidConfigError(
- error_msg=(
- 'The profile "%s" contains both source_profile and '
- 'credential_source.' % profile_name
- )
- )
- elif credential_source is None and source_profile is None:
- raise PartialCredentialsError(
- provider=self.METHOD,
- cred_var='source_profile or credential_source'
- )
- elif credential_source is not None:
- self._validate_credential_source(
- profile_name, credential_source)
- else:
- self._validate_source_profile(profile_name, source_profile)
-
- return role_config
-
- def _validate_credential_source(self, parent_profile, credential_source):
- if self._credential_sourcer is None:
- raise InvalidConfigError(error_msg=(
- 'The credential_source "%s" is specified in profile "%s", '
- 'but no source provider was configured.' % (
- credential_source, parent_profile)
- ))
- if not self._credential_sourcer.is_supported(credential_source):
- raise InvalidConfigError(error_msg=(
- 'The credential source "%s" referenced in profile "%s" is not '
- 'valid.' % (credential_source, parent_profile)
- ))
-
- def _source_profile_has_credentials(self, profile):
- return any([
- self._has_static_credentials(profile),
- self._has_assume_role_config_vars(profile),
- ])
-
- def _validate_source_profile(self, parent_profile_name,
- source_profile_name):
- profiles = self._loaded_config.get('profiles', {})
- if source_profile_name not in profiles:
- raise InvalidConfigError(
- error_msg=(
- 'The source_profile "%s" referenced in '
- 'the profile "%s" does not exist.' % (
- source_profile_name, parent_profile_name)
- )
- )
-
- source_profile = profiles[source_profile_name]
-
- # Ensure the profile has valid credential type
- if not self._source_profile_has_credentials(source_profile):
- raise InvalidConfigError(
- error_msg=(
- 'The source_profile "%s" must specify either static '
- 'credentials or an assume role configuration' % (
- source_profile_name)
- )
- )
-
- # Make sure we aren't going into an infinite loop. If we haven't
- # visited the profile yet, we're good.
- if source_profile_name not in self._visited_profiles:
- return
-
- # If we have visited the profile and the profile isn't simply
- # referencing itself, that's an infinite loop.
- if source_profile_name != parent_profile_name:
- raise InfiniteLoopConfigError(
- source_profile=source_profile_name,
- visited_profiles=self._visited_profiles
- )
-
- # A profile is allowed to reference itself so that it can source
- # static credentials and have configuration all in the same
- # profile. This will only ever work for the top level assume
- # role because the static credentials will otherwise take
- # precedence.
- if not self._has_static_credentials(source_profile):
- raise InfiniteLoopConfigError(
- source_profile=source_profile_name,
- visited_profiles=self._visited_profiles
- )
-
- def _has_static_credentials(self, profile):
- static_keys = ['aws_secret_access_key', 'aws_access_key_id']
- return any(static_key in profile for static_key in static_keys)
-
- def _resolve_source_credentials(self, role_config, profile_name):
- credential_source = role_config.get('credential_source')
- if credential_source is not None:
- return self._resolve_credentials_from_source(
- credential_source, profile_name
- )
-
- source_profile = role_config['source_profile']
- self._visited_profiles.append(source_profile)
- return self._resolve_credentials_from_profile(source_profile)
-
- def _resolve_credentials_from_profile(self, profile_name):
- profiles = self._loaded_config.get('profiles', {})
- profile = profiles[profile_name]
-
- if self._has_static_credentials(profile):
- return self._resolve_static_credentials_from_profile(profile)
-
- return self._load_creds_via_assume_role(profile_name)
-
- def _resolve_static_credentials_from_profile(self, profile):
- try:
- return Credentials(
- access_key=profile['aws_access_key_id'],
- secret_key=profile['aws_secret_access_key'],
- token=profile.get('aws_session_token')
- )
- except KeyError as e:
- raise PartialCredentialsError(
- provider=self.METHOD, cred_var=str(e))
-
- def _resolve_credentials_from_source(self, credential_source,
- profile_name):
- credentials = self._credential_sourcer.source_credentials(
- credential_source)
- if credentials is None:
- raise CredentialRetrievalError(
- provider=credential_source,
- error_msg=(
- 'No credentials found in credential_source referenced '
- 'in profile %s' % profile_name
- )
- )
- return credentials
-
-
-class CanonicalNameCredentialSourcer(object):
- def __init__(self, providers):
- self._providers = providers
-
- def is_supported(self, source_name):
- """Validates a given source name.
-
- :type source_name: str
- :param source_name: The value of credential_source in the config
- file. This is the canonical name of the credential provider.
-
- :rtype: bool
- :returns: True if the credential provider is supported,
- False otherwise.
- """
- return source_name in [p.CANONICAL_NAME for p in self._providers]
-
- def source_credentials(self, source_name):
- """Loads source credentials based on the provided configuration.
-
- :type source_name: str
- :param source_name: The value of credential_source in the config
- file. This is the canonical name of the credential provider.
-
- :rtype: Credentials
- """
- source = self._get_provider(source_name)
- if isinstance(source, CredentialResolver):
- return source.load_credentials()
- return source.load()
-
- def _get_provider(self, canonical_name):
- """Return a credential provider by its canonical name.
-
- :type canonical_name: str
- :param canonical_name: The canonical name of the provider.
-
- :raises UnknownCredentialError: Raised if no
- credential provider by the provided name
- is found.
- """
- provider = self._get_provider_by_canonical_name(canonical_name)
-
- # The AssumeRole provider should really be part of the SharedConfig
- # provider rather than being its own thing, but it is not. It is
- # effectively part of both the SharedConfig provider and the
- # SharedCredentials provider now due to the way it behaves.
- # Therefore if we want either of those providers we should return
- # the AssumeRole provider with it.
- if canonical_name.lower() in ['sharedconfig', 'sharedcredentials']:
- assume_role_provider = self._get_provider_by_method('assume-role')
- if assume_role_provider is not None:
- # The SharedConfig or SharedCredentials provider may not be
- # present if it was removed for some reason, but the
- # AssumeRole provider could still be present. In that case,
- # return the assume role provider by itself.
- if provider is None:
- return assume_role_provider
-
- # If both are present, return them both as a
- # CredentialResolver so that calling code can treat them as
- # a single entity.
- return CredentialResolver([assume_role_provider, provider])
-
- if provider is None:
- raise UnknownCredentialError(name=canonical_name)
-
- return provider
-
- def _get_provider_by_canonical_name(self, canonical_name):
- """Return a credential provider by its canonical name.
-
- This function is strict, it does not attempt to address
- compatibility issues.
- """
- for provider in self._providers:
- name = provider.CANONICAL_NAME
- # Canonical names are case-insensitive
- if name and name.lower() == canonical_name.lower():
- return provider
-
- def _get_provider_by_method(self, method):
- """Return a credential provider by its METHOD name."""
- for provider in self._providers:
- if provider.METHOD == method:
- return provider
-
-
-class ContainerProvider(CredentialProvider):
- METHOD = 'container-role'
- CANONICAL_NAME = 'EcsContainer'
- ENV_VAR = 'AWS_CONTAINER_CREDENTIALS_RELATIVE_URI'
- ENV_VAR_FULL = 'AWS_CONTAINER_CREDENTIALS_FULL_URI'
- ENV_VAR_AUTH_TOKEN = 'AWS_CONTAINER_AUTHORIZATION_TOKEN'
-
- def __init__(self, environ=None, fetcher=None):
- if environ is None:
- environ = os.environ
- if fetcher is None:
- fetcher = ContainerMetadataFetcher()
- self._environ = environ
- self._fetcher = fetcher
-
- def load(self):
- # This cred provider is only triggered if the self.ENV_VAR is set,
- # which only happens if you opt into this feature.
- if self.ENV_VAR in self._environ or self.ENV_VAR_FULL in self._environ:
- return self._retrieve_or_fail()
-
- def _retrieve_or_fail(self):
- if self._provided_relative_uri():
- full_uri = self._fetcher.full_url(self._environ[self.ENV_VAR])
- else:
- full_uri = self._environ[self.ENV_VAR_FULL]
- headers = self._build_headers()
- fetcher = self._create_fetcher(full_uri, headers)
- creds = fetcher()
- return RefreshableCredentials(
- access_key=creds['access_key'],
- secret_key=creds['secret_key'],
- token=creds['token'],
- method=self.METHOD,
- expiry_time=_parse_if_needed(creds['expiry_time']),
- refresh_using=fetcher,
- )
-
- def _build_headers(self):
- headers = {}
- auth_token = self._environ.get(self.ENV_VAR_AUTH_TOKEN)
- if auth_token is not None:
- return {
- 'Authorization': auth_token
- }
-
- def _create_fetcher(self, full_uri, headers):
- def fetch_creds():
- try:
- response = self._fetcher.retrieve_full_uri(
- full_uri, headers=headers)
- except MetadataRetrievalError as e:
- logger.debug("Error retrieving container metadata: %s", e,
- exc_info=True)
- raise CredentialRetrievalError(provider=self.METHOD,
- error_msg=str(e))
- return {
- 'access_key': response['AccessKeyId'],
- 'secret_key': response['SecretAccessKey'],
- 'token': response['Token'],
- 'expiry_time': response['Expiration'],
- }
-
- return fetch_creds
-
- def _provided_relative_uri(self):
- return self.ENV_VAR in self._environ
-
-
-class CredentialResolver(object):
- def __init__(self, providers):
- """
-
- :param providers: A list of ``CredentialProvider`` instances.
-
- """
- self.providers = providers
-
- def insert_before(self, name, credential_provider):
- """
- Inserts a new instance of ``CredentialProvider`` into the chain that
- will be tried before an existing one.
-
- :param name: The short name of the credentials you'd like to insert the
- new credentials before. (ex. ``env`` or ``config``). Existing names
- & ordering can be discovered via ``self.available_methods``.
- :type name: string
-
- :param cred_instance: An instance of the new ``Credentials`` object
- you'd like to add to the chain.
- :type cred_instance: A subclass of ``Credentials``
- """
- try:
- offset = [p.METHOD for p in self.providers].index(name)
- except ValueError:
- raise UnknownCredentialError(name=name)
- self.providers.insert(offset, credential_provider)
-
- def insert_after(self, name, credential_provider):
- """
- Inserts a new type of ``Credentials`` instance into the chain that will
- be tried after an existing one.
-
- :param name: The short name of the credentials you'd like to insert the
- new credentials after. (ex. ``env`` or ``config``). Existing names
- & ordering can be discovered via ``self.available_methods``.
- :type name: string
-
- :param cred_instance: An instance of the new ``Credentials`` object
- you'd like to add to the chain.
- :type cred_instance: A subclass of ``Credentials``
- """
- offset = self._get_provider_offset(name)
- self.providers.insert(offset + 1, credential_provider)
-
- def remove(self, name):
- """
- Removes a given ``Credentials`` instance from the chain.
-
- :param name: The short name of the credentials instance to remove.
- :type name: string
- """
- available_methods = [p.METHOD for p in self.providers]
- if name not in available_methods:
- # It's not present. Fail silently.
- return
-
- offset = available_methods.index(name)
- self.providers.pop(offset)
-
- def get_provider(self, name):
- """Return a credential provider by name.
-
- :type name: str
- :param name: The name of the provider.
-
- :raises UnknownCredentialError: Raised if no
- credential provider by the provided name
- is found.
- """
- return self.providers[self._get_provider_offset(name)]
-
- def _get_provider_offset(self, name):
- try:
- return [p.METHOD for p in self.providers].index(name)
- except ValueError:
- raise UnknownCredentialError(name=name)
-
- def load_credentials(self):
- """
- Goes through the credentials chain, returning the first ``Credentials``
- that could be loaded.
- """
- # First provider to return a non-None response wins.
- for provider in self.providers:
- logger.debug("Looking for credentials via: %s", provider.METHOD)
- creds = provider.load()
- if creds is not None:
- return creds
-
- # If we got here, no credentials could be found.
- # This feels like it should be an exception, but historically, ``None``
- # is returned.
- #
- # +1
- # -js
- return None
diff --git a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/_retry.json b/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/_retry.json
deleted file mode 100644
index c477c9bd..00000000
--- a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/_retry.json
+++ /dev/null
@@ -1,261 +0,0 @@
-{
- "definitions": {
- "throttling": {
- "applies_when": {
- "response": {
- "service_error_code": "Throttling",
- "http_status_code": 400
- }
- }
- },
- "throttling_exception": {
- "applies_when": {
- "response": {
- "service_error_code": "ThrottlingException",
- "http_status_code": 400
- }
- }
- },
- "throttled_exception": {
- "applies_when": {
- "response": {
- "service_error_code": "ThrottledException",
- "http_status_code": 400
- }
- }
- },
- "request_throttled_exception": {
- "applies_when": {
- "response": {
- "service_error_code": "RequestThrottledException",
- "http_status_code": 400
- }
- }
- },
- "too_many_requests": {
- "applies_when": {
- "response": {
- "http_status_code": 429
- }
- }
- },
- "general_socket_errors": {
- "applies_when": {
- "socket_errors": ["GENERAL_CONNECTION_ERROR"]
- }
- },
- "general_server_error": {
- "applies_when": {
- "response": {
- "http_status_code": 500
- }
- }
- },
- "bad_gateway": {
- "applies_when": {
- "response": {
- "http_status_code": 502
- }
- }
- },
- "service_unavailable": {
- "applies_when": {
- "response": {
- "http_status_code": 503
- }
- }
- },
- "gateway_timeout": {
- "applies_when": {
- "response": {
- "http_status_code": 504
- }
- }
- },
- "limit_exceeded": {
- "applies_when": {
- "response": {
- "http_status_code": 509
- }
- }
- }
- },
- "retry": {
- "__default__": {
- "max_attempts": 5,
- "delay": {
- "type": "exponential",
- "base": "rand",
- "growth_factor": 2
- },
- "policies": {
- "general_socket_errors": {"$ref": "general_socket_errors"},
- "general_server_error": {"$ref": "general_server_error"},
- "bad_gateway": {"$ref": "bad_gateway"},
- "service_unavailable": {"$ref": "service_unavailable"},
- "gateway_timeout": {"$ref": "gateway_timeout"},
- "limit_exceeded": {"$ref": "limit_exceeded"},
- "throttling_exception": {"$ref": "throttling_exception"},
- "throttled_exception": {"$ref": "throttled_exception"},
- "request_throttled_exception": {"$ref": "request_throttled_exception"},
- "throttling": {"$ref": "throttling"},
- "too_many_requests": {"$ref": "too_many_requests"}
- }
- },
- "organizations": {
- "__default__": {
- "policies": {
- "too_many_requests": {
- "applies_when": {
- "response": {
- "service_error_code": "TooManyRequestsException",
- "http_status_code": 400
- }
- }
- }
- }
- }
- },
- "dynamodb": {
- "__default__": {
- "max_attempts": 10,
- "delay": {
- "type": "exponential",
- "base": 0.05,
- "growth_factor": 2
- },
- "policies": {
- "throughput_exceeded": {
- "applies_when": {
- "response": {
- "service_error_code": "ProvisionedThroughputExceededException",
- "http_status_code": 400
- }
- }
- },
- "crc32": {
- "applies_when": {
- "response": {
- "crc32body": "x-amz-crc32"
- }
- }
- }
- }
- }
- },
- "ec2": {
- "__default__": {
- "policies": {
- "request_limit_exceeded": {
- "applies_when": {
- "response": {
- "service_error_code": "RequestLimitExceeded",
- "http_status_code": 503
- }
- }
- }
- }
- }
- },
- "cloudsearch": {
- "__default__": {
- "policies": {
- "request_limit_exceeded": {
- "applies_when": {
- "response": {
- "service_error_code": "BandwidthLimitExceeded",
- "http_status_code": 509
- }
- }
- }
- }
- }
- },
- "kinesis": {
- "DescribeStream": {
- "policies": {
- "request_limit_exceeded": {
- "applies_when": {
- "response": {
- "service_error_code": "LimitExceededException",
- "http_status_code": 400
- }
- }
- }
- }
- }
- },
- "sqs": {
- "__default__": {
- "policies": {
- "request_limit_exceeded": {
- "applies_when": {
- "response": {
- "service_error_code": "RequestThrottled",
- "http_status_code": 403
- }
- }
- }
- }
- }
- },
- "s3": {
- "__default__": {
- "policies": {
- "timeouts": {
- "applies_when": {
- "response": {
- "http_status_code": 400,
- "service_error_code": "RequestTimeout"
- }
- }
- },
- "contentmd5": {
- "applies_when": {
- "response": {
- "http_status_code": 400,
- "service_error_code": "BadDigest"
- }
- }
- }
- }
- }
- },
- "glacier": {
- "__default__": {
- "policies": {
- "timeouts": {
- "applies_when": {
- "response": {
- "http_status_code": 408,
- "service_error_code": "RequestTimeoutException"
- }
- }
- }
- }
- }
- },
- "route53": {
- "__default__": {
- "policies": {
- "request_limit_exceeded": {
- "applies_when": {
- "response": {
- "service_error_code": "Throttling",
- "http_status_code": 400
- }
- }
- },
- "still_processing": {
- "applies_when": {
- "response": {
- "service_error_code": "PriorRequestNotComplete",
- "http_status_code": 400
- }
- }
- }
- }
- }
- }
- }
-}
diff --git a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/acm-pca/2017-08-22/paginators-1.json b/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/acm-pca/2017-08-22/paginators-1.json
deleted file mode 100644
index ea142457..00000000
--- a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/acm-pca/2017-08-22/paginators-1.json
+++ /dev/null
@@ -1,3 +0,0 @@
-{
- "pagination": {}
-}
diff --git a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/acm-pca/2017-08-22/service-2.json b/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/acm-pca/2017-08-22/service-2.json
deleted file mode 100644
index f24c7ba6..00000000
--- a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/acm-pca/2017-08-22/service-2.json
+++ /dev/null
@@ -1,1261 +0,0 @@
-{
- "version":"2.0",
- "metadata":{
- "apiVersion":"2017-08-22",
- "endpointPrefix":"acm-pca",
- "jsonVersion":"1.1",
- "protocol":"json",
- "serviceAbbreviation":"ACM-PCA",
- "serviceFullName":"AWS Certificate Manager Private Certificate Authority",
- "serviceId":"ACM PCA",
- "signatureVersion":"v4",
- "targetPrefix":"ACMPrivateCA",
- "uid":"acm-pca-2017-08-22"
- },
- "operations":{
- "CreateCertificateAuthority":{
- "name":"CreateCertificateAuthority",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"CreateCertificateAuthorityRequest"},
- "output":{"shape":"CreateCertificateAuthorityResponse"},
- "errors":[
- {"shape":"InvalidArgsException"},
- {"shape":"InvalidPolicyException"},
- {"shape":"LimitExceededException"}
- ],
- "documentation":"Creates a private subordinate certificate authority (CA). You must specify the CA configuration, the revocation configuration, the CA type, and an optional idempotency token. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses to sign, and X.500 subject information. The CRL (certificate revocation list) configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this operation returns the Amazon Resource Name (ARN) of the CA.
",
- "idempotent":true
- },
- "CreateCertificateAuthorityAuditReport":{
- "name":"CreateCertificateAuthorityAuditReport",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"CreateCertificateAuthorityAuditReportRequest"},
- "output":{"shape":"CreateCertificateAuthorityAuditReportResponse"},
- "errors":[
- {"shape":"RequestInProgressException"},
- {"shape":"RequestFailedException"},
- {"shape":"ResourceNotFoundException"},
- {"shape":"InvalidArnException"},
- {"shape":"InvalidArgsException"},
- {"shape":"InvalidStateException"}
- ],
- "documentation":"Creates an audit report that lists every time that the your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate operations use the private key. You can generate a new report every 30 minutes.
",
- "idempotent":true
- },
- "DeleteCertificateAuthority":{
- "name":"DeleteCertificateAuthority",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"DeleteCertificateAuthorityRequest"},
- "errors":[
- {"shape":"ConcurrentModificationException"},
- {"shape":"ResourceNotFoundException"},
- {"shape":"InvalidArnException"},
- {"shape":"InvalidStateException"}
- ],
- "documentation":"Deletes a private certificate authority (CA). You must provide the ARN (Amazon Resource Name) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities operation. Before you can delete a CA, you must disable it. Call the UpdateCertificateAuthority operation and set the CertificateAuthorityStatus parameter to DISABLED.
Additionally, you can delete a CA if you are waiting for it to be created (the Status field of the CertificateAuthority is CREATING). You can also delete it if the CA has been created but you haven't yet imported the signed certificate (the Status is PENDING_CERTIFICATE) into ACM PCA.
If the CA is in one of the aforementioned states and you call DeleteCertificateAuthority, the CA's status changes to DELETED. However, the CA won't be permentantly deleted until the restoration period has passed. By default, if you do not set the PermanentDeletionTimeInDays parameter, the CA remains restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority operation returns the time remaining in the restoration window of a Private CA in the DELETED state. To restore an eligable CA, call the RestoreCertificateAuthority operation.
"
- },
- "DescribeCertificateAuthority":{
- "name":"DescribeCertificateAuthority",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"DescribeCertificateAuthorityRequest"},
- "output":{"shape":"DescribeCertificateAuthorityResponse"},
- "errors":[
- {"shape":"ResourceNotFoundException"},
- {"shape":"InvalidArnException"}
- ],
- "documentation":"Lists information about your private certificate authority (CA). You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:
-
CREATING - ACM PCA is creating your private certificate authority.
-
PENDING_CERTIFICATE - The certificate is pending. You must use your on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA.
-
ACTIVE - Your private CA is active.
-
DISABLED - Your private CA has been disabled.
-
EXPIRED - Your private CA certificate has expired.
-
FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.
-
DELETED - Your private CA is within the restoration period, after which it will be permanently deleted. The length of time remaining in the CA's restoration period will also be included in this operation's output.
"
- },
- "DescribeCertificateAuthorityAuditReport":{
- "name":"DescribeCertificateAuthorityAuditReport",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"DescribeCertificateAuthorityAuditReportRequest"},
- "output":{"shape":"DescribeCertificateAuthorityAuditReportResponse"},
- "errors":[
- {"shape":"ResourceNotFoundException"},
- {"shape":"InvalidArnException"},
- {"shape":"InvalidArgsException"}
- ],
- "documentation":"Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport operation. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate operation or the RevokeCertificate operation.
"
- },
- "GetCertificate":{
- "name":"GetCertificate",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"GetCertificateRequest"},
- "output":{"shape":"GetCertificateResponse"},
- "errors":[
- {"shape":"RequestInProgressException"},
- {"shape":"RequestFailedException"},
- {"shape":"ResourceNotFoundException"},
- {"shape":"InvalidArnException"},
- {"shape":"InvalidStateException"}
- ],
- "documentation":"Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the IssueCertificate operation. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate operation. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport operation to create a report that contains information about all of the certificates issued and revoked by your private CA.
"
- },
- "GetCertificateAuthorityCertificate":{
- "name":"GetCertificateAuthorityCertificate",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"GetCertificateAuthorityCertificateRequest"},
- "output":{"shape":"GetCertificateAuthorityCertificateResponse"},
- "errors":[
- {"shape":"ResourceNotFoundException"},
- {"shape":"InvalidStateException"},
- {"shape":"InvalidArnException"}
- ],
- "documentation":"Retrieves the certificate and certificate chain for your private certificate authority (CA). Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it.
"
- },
- "GetCertificateAuthorityCsr":{
- "name":"GetCertificateAuthorityCsr",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"GetCertificateAuthorityCsrRequest"},
- "output":{"shape":"GetCertificateAuthorityCsrResponse"},
- "errors":[
- {"shape":"RequestInProgressException"},
- {"shape":"RequestFailedException"},
- {"shape":"ResourceNotFoundException"},
- {"shape":"InvalidArnException"},
- {"shape":"InvalidStateException"}
- ],
- "documentation":"Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority operation. Take the CSR to your on-premises X.509 infrastructure and sign it by using your root or a subordinate CA. Then import the signed certificate back into ACM PCA by calling the ImportCertificateAuthorityCertificate operation. The CSR is returned as a base64 PEM-encoded string.
"
- },
- "ImportCertificateAuthorityCertificate":{
- "name":"ImportCertificateAuthorityCertificate",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"ImportCertificateAuthorityCertificateRequest"},
- "errors":[
- {"shape":"ConcurrentModificationException"},
- {"shape":"RequestInProgressException"},
- {"shape":"RequestFailedException"},
- {"shape":"ResourceNotFoundException"},
- {"shape":"InvalidArnException"},
- {"shape":"InvalidStateException"},
- {"shape":"MalformedCertificateException"},
- {"shape":"CertificateMismatchException"}
- ],
- "documentation":"Imports your signed private CA certificate into ACM PCA. Before you can call this operation, you must create the private certificate authority by calling the CreateCertificateAuthority operation. You must then generate a certificate signing request (CSR) by calling the GetCertificateAuthorityCsr operation. Take the CSR to your on-premises CA and use the root certificate or a subordinate certificate to sign it. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.
Your certificate chain must not include the private CA certificate that you are importing.
Your on-premises CA certificate must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built.
The chain must be PEM-encoded.
"
- },
- "IssueCertificate":{
- "name":"IssueCertificate",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"IssueCertificateRequest"},
- "output":{"shape":"IssueCertificateResponse"},
- "errors":[
- {"shape":"LimitExceededException"},
- {"shape":"ResourceNotFoundException"},
- {"shape":"InvalidStateException"},
- {"shape":"InvalidArnException"},
- {"shape":"InvalidArgsException"},
- {"shape":"MalformedCSRException"}
- ],
- "documentation":"Uses your private certificate authority (CA) to issue a client certificate. This operation returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate operation and specifying the ARN.
You cannot use the ACM ListCertificateAuthorities operation to retrieve the ARNs of the certificates that you issue by using ACM PCA.
",
- "idempotent":true
- },
- "ListCertificateAuthorities":{
- "name":"ListCertificateAuthorities",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"ListCertificateAuthoritiesRequest"},
- "output":{"shape":"ListCertificateAuthoritiesResponse"},
- "errors":[
- {"shape":"InvalidNextTokenException"}
- ],
- "documentation":"Lists the private certificate authorities that you created by using the CreateCertificateAuthority operation.
"
- },
- "ListTags":{
- "name":"ListTags",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"ListTagsRequest"},
- "output":{"shape":"ListTagsResponse"},
- "errors":[
- {"shape":"ResourceNotFoundException"},
- {"shape":"InvalidArnException"}
- ],
- "documentation":"Lists the tags, if any, that are associated with your private CA. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority operation to add one or more tags to your CA. Call the UntagCertificateAuthority operation to remove tags.
"
- },
- "RestoreCertificateAuthority":{
- "name":"RestoreCertificateAuthority",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"RestoreCertificateAuthorityRequest"},
- "errors":[
- {"shape":"ResourceNotFoundException"},
- {"shape":"InvalidStateException"},
- {"shape":"InvalidArnException"}
- ],
- "documentation":"Restores a certificate authority (CA) that is in the DELETED state. You can restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority operation. Currently, you can specify 7 to 30 days. If you did not specify a PermanentDeletionTimeInDays value, by default you can restore the CA at any time in a 30 day period. You can check the time remaining in the restoration period of a private CA in the DELETED state by calling the DescribeCertificateAuthority or ListCertificateAuthorities operations. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority operation returns. To change its status to ACTIVE, call the UpdateCertificateAuthority operation. If the private CA was in the PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate operation to import a certificate authority into the private CA before it can be activated. You cannot restore a CA after the restoration period has ended.
"
- },
- "RevokeCertificate":{
- "name":"RevokeCertificate",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"RevokeCertificateRequest"},
- "errors":[
- {"shape":"ConcurrentModificationException"},
- {"shape":"InvalidArnException"},
- {"shape":"InvalidStateException"},
- {"shape":"ResourceNotFoundException"},
- {"shape":"RequestAlreadyProcessedException"},
- {"shape":"RequestInProgressException"},
- {"shape":"RequestFailedException"}
- ],
- "documentation":"Revokes a certificate that you issued by calling the IssueCertificate operation. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. ACM PCA writes the CRL to an S3 bucket that you specify. For more information about revocation, see the CrlConfiguration structure. ACM PCA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.
"
- },
- "TagCertificateAuthority":{
- "name":"TagCertificateAuthority",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"TagCertificateAuthorityRequest"},
- "errors":[
- {"shape":"ResourceNotFoundException"},
- {"shape":"InvalidArnException"},
- {"shape":"InvalidStateException"},
- {"shape":"InvalidTagException"},
- {"shape":"TooManyTagsException"}
- ],
- "documentation":"Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the UntagCertificateAuthority operation. Call the ListTags operation to see what tags are associated with your CA.
"
- },
- "UntagCertificateAuthority":{
- "name":"UntagCertificateAuthority",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"UntagCertificateAuthorityRequest"},
- "errors":[
- {"shape":"ResourceNotFoundException"},
- {"shape":"InvalidArnException"},
- {"shape":"InvalidStateException"},
- {"shape":"InvalidTagException"}
- ],
- "documentation":"Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this operation, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the TagCertificateAuthority. Call the ListTags operation to see what tags are associated with your CA.
"
- },
- "UpdateCertificateAuthority":{
- "name":"UpdateCertificateAuthority",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"UpdateCertificateAuthorityRequest"},
- "errors":[
- {"shape":"ConcurrentModificationException"},
- {"shape":"ResourceNotFoundException"},
- {"shape":"InvalidArgsException"},
- {"shape":"InvalidArnException"},
- {"shape":"InvalidStateException"},
- {"shape":"InvalidPolicyException"}
- ],
- "documentation":"Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the ACTIVE or DISABLED state before you can update it. You can disable a private CA that is in the ACTIVE state or make a CA that is in the DISABLED state active again.
"
- }
- },
- "shapes":{
- "ASN1Subject":{
- "type":"structure",
- "members":{
- "Country":{
- "shape":"CountryCodeString",
- "documentation":"Two-digit code that specifies the country in which the certificate subject located.
"
- },
- "Organization":{
- "shape":"String64",
- "documentation":"Legal name of the organization with which the certificate subject is affiliated.
"
- },
- "OrganizationalUnit":{
- "shape":"String64",
- "documentation":"A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
"
- },
- "DistinguishedNameQualifier":{
- "shape":"DistinguishedNameQualifierString",
- "documentation":"Disambiguating information for the certificate subject.
"
- },
- "State":{
- "shape":"String128",
- "documentation":"State in which the subject of the certificate is located.
"
- },
- "CommonName":{
- "shape":"String64",
- "documentation":"Fully qualified domain name (FQDN) associated with the certificate subject.
"
- },
- "SerialNumber":{
- "shape":"String64",
- "documentation":"The certificate serial number.
"
- },
- "Locality":{
- "shape":"String128",
- "documentation":"The locality (such as a city or town) in which the certificate subject is located.
"
- },
- "Title":{
- "shape":"String64",
- "documentation":"A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.
"
- },
- "Surname":{
- "shape":"String40",
- "documentation":"Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.
"
- },
- "GivenName":{
- "shape":"String16",
- "documentation":"First name.
"
- },
- "Initials":{
- "shape":"String5",
- "documentation":"Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the SurName.
"
- },
- "Pseudonym":{
- "shape":"String128",
- "documentation":"Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.
"
- },
- "GenerationQualifier":{
- "shape":"String3",
- "documentation":"Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.
"
- }
- },
- "documentation":"Contains information about the certificate subject. The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each entity, but your private CA can issue more than one certificate with the same DN to the same entity.
"
- },
- "Arn":{
- "type":"string",
- "max":200,
- "min":5,
- "pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=/,.@-]+)*"
- },
- "AuditReportId":{
- "type":"string",
- "max":36,
- "min":36,
- "pattern":"[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}"
- },
- "AuditReportResponseFormat":{
- "type":"string",
- "enum":[
- "JSON",
- "CSV"
- ]
- },
- "AuditReportStatus":{
- "type":"string",
- "enum":[
- "CREATING",
- "SUCCESS",
- "FAILED"
- ]
- },
- "Boolean":{"type":"boolean"},
- "CertificateAuthorities":{
- "type":"list",
- "member":{"shape":"CertificateAuthority"}
- },
- "CertificateAuthority":{
- "type":"structure",
- "members":{
- "Arn":{
- "shape":"Arn",
- "documentation":"Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012 .
"
- },
- "CreatedAt":{
- "shape":"TStamp",
- "documentation":"Date and time at which your private CA was created.
"
- },
- "LastStateChangeAt":{
- "shape":"TStamp",
- "documentation":"Date and time at which your private CA was last updated.
"
- },
- "Type":{
- "shape":"CertificateAuthorityType",
- "documentation":"Type of your private CA.
"
- },
- "Serial":{
- "shape":"String",
- "documentation":"Serial number of your private CA.
"
- },
- "Status":{
- "shape":"CertificateAuthorityStatus",
- "documentation":"Status of your private CA.
"
- },
- "NotBefore":{
- "shape":"TStamp",
- "documentation":"Date and time before which your private CA certificate is not valid.
"
- },
- "NotAfter":{
- "shape":"TStamp",
- "documentation":"Date and time after which your private CA certificate is not valid.
"
- },
- "FailureReason":{
- "shape":"FailureReason",
- "documentation":"Reason the request to create your private CA failed.
"
- },
- "CertificateAuthorityConfiguration":{
- "shape":"CertificateAuthorityConfiguration",
- "documentation":"Your private CA configuration.
"
- },
- "RevocationConfiguration":{
- "shape":"RevocationConfiguration",
- "documentation":"Information about the certificate revocation list (CRL) created and maintained by your private CA.
"
- },
- "RestorableUntil":{
- "shape":"TStamp",
- "documentation":"The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest operation.
"
- }
- },
- "documentation":"Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate Subject field owns or controls the public key contained in the Subject Public Key Info field. Call the CreateCertificateAuthority operation to create your private CA. You must then call the GetCertificateAuthorityCertificate operation to retrieve a private CA certificate signing request (CSR). Take the CSR to your on-premises CA and sign it with the root CA certificate or a subordinate certificate. Call the ImportCertificateAuthorityCertificate operation to import the signed certificate into AWS Certificate Manager (ACM).
"
- },
- "CertificateAuthorityConfiguration":{
- "type":"structure",
- "required":[
- "KeyAlgorithm",
- "SigningAlgorithm",
- "Subject"
- ],
- "members":{
- "KeyAlgorithm":{
- "shape":"KeyAlgorithm",
- "documentation":"Type of the public key algorithm and size, in bits, of the key pair that your key pair creates when it issues a certificate.
"
- },
- "SigningAlgorithm":{
- "shape":"SigningAlgorithm",
- "documentation":"Name of the algorithm your private CA uses to sign certificate requests.
"
- },
- "Subject":{
- "shape":"ASN1Subject",
- "documentation":"Structure that contains X.500 distinguished name information for your private CA.
"
- }
- },
- "documentation":"Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate, the signature algorithm it uses used when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the CreateCertificateAuthority operation.
"
- },
- "CertificateAuthorityStatus":{
- "type":"string",
- "enum":[
- "CREATING",
- "PENDING_CERTIFICATE",
- "ACTIVE",
- "DELETED",
- "DISABLED",
- "EXPIRED",
- "FAILED"
- ]
- },
- "CertificateAuthorityType":{
- "type":"string",
- "enum":["SUBORDINATE"]
- },
- "CertificateBody":{"type":"string"},
- "CertificateBodyBlob":{
- "type":"blob",
- "max":32768,
- "min":1
- },
- "CertificateChain":{"type":"string"},
- "CertificateChainBlob":{
- "type":"blob",
- "max":2097152,
- "min":0
- },
- "CertificateMismatchException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"The certificate authority certificate you are importing does not comply with conditions specified in the certificate that signed it.
",
- "exception":true
- },
- "ConcurrentModificationException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"A previous update to your private CA is still ongoing.
",
- "exception":true
- },
- "CountryCodeString":{
- "type":"string",
- "pattern":"[A-Za-z]{2}"
- },
- "CreateCertificateAuthorityAuditReportRequest":{
- "type":"structure",
- "required":[
- "CertificateAuthorityArn",
- "S3BucketName",
- "AuditReportResponseFormat"
- ],
- "members":{
- "CertificateAuthorityArn":{
- "shape":"Arn",
- "documentation":"Amazon Resource Name (ARN) of the CA to be audited. This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
"
- },
- "S3BucketName":{
- "shape":"String",
- "documentation":"Name of the S3 bucket that will contain the audit report.
"
- },
- "AuditReportResponseFormat":{
- "shape":"AuditReportResponseFormat",
- "documentation":"Format in which to create the report. This can be either JSON or CSV.
"
- }
- }
- },
- "CreateCertificateAuthorityAuditReportResponse":{
- "type":"structure",
- "members":{
- "AuditReportId":{
- "shape":"AuditReportId",
- "documentation":"An alphanumeric string that contains a report identifier.
"
- },
- "S3Key":{
- "shape":"String",
- "documentation":"The key that uniquely identifies the report file in your S3 bucket.
"
- }
- }
- },
- "CreateCertificateAuthorityRequest":{
- "type":"structure",
- "required":[
- "CertificateAuthorityConfiguration",
- "CertificateAuthorityType"
- ],
- "members":{
- "CertificateAuthorityConfiguration":{
- "shape":"CertificateAuthorityConfiguration",
- "documentation":"Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.
"
- },
- "RevocationConfiguration":{
- "shape":"RevocationConfiguration",
- "documentation":"Contains a Boolean value that you can use to enable a certification revocation list (CRL) for the CA, the name of the S3 bucket to which ACM PCA will write the CRL, and an optional CNAME alias that you can use to hide the name of your bucket in the CRL Distribution Points extension of your CA certificate. For more information, see the CrlConfiguration structure.
"
- },
- "CertificateAuthorityType":{
- "shape":"CertificateAuthorityType",
- "documentation":"The type of the certificate authority. Currently, this must be SUBORDINATE.
"
- },
- "IdempotencyToken":{
- "shape":"IdempotencyToken",
- "documentation":"Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority. Idempotency tokens time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within a five minute period, ACM PCA recognizes that you are requesting only one certificate. As a result, ACM PCA issues only one. If you change the idempotency token for each call, however, ACM PCA recognizes that you are requesting multiple certificates.
"
- }
- }
- },
- "CreateCertificateAuthorityResponse":{
- "type":"structure",
- "members":{
- "CertificateAuthorityArn":{
- "shape":"Arn",
- "documentation":"If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
"
- }
- }
- },
- "CrlConfiguration":{
- "type":"structure",
- "required":["Enabled"],
- "members":{
- "Enabled":{
- "shape":"Boolean",
- "documentation":"Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority operation or for an existing CA when you call the UpdateCertificateAuthority operation.
",
- "box":true
- },
- "ExpirationInDays":{
- "shape":"Integer1To5000",
- "documentation":"Number of days until a certificate expires.
",
- "box":true
- },
- "CustomCname":{
- "shape":"String253",
- "documentation":"Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point. Use this value if you don't want the name of your S3 bucket to be public.
"
- },
- "S3BucketName":{
- "shape":"String3To255",
- "documentation":"Name of the S3 bucket that contains the CRL. If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket policy that allows ACM PCA to write the CRL to your bucket.
"
- }
- },
- "documentation":"Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the Enabled parameter to true. Your private CA writes CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by specifying a value for the CustomCname parameter. Your private CA copies the CNAME or the S3 bucket name to the CRL Distribution Points extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM PCA.
Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked. When a certificate is revoked, it is recorded in the next CRL that is generated and in the next audit report. Only time valid certificates are listed in the CRL. Expired certificates are not included.
CRLs contain the following fields:
-
Version: The current version number defined in RFC 5280 is V2. The integer value is 0x1.
-
Signature Algorithm: The name of the algorithm used to sign the CRL.
-
Issuer: The X.500 distinguished name of your private CA that issued the CRL.
-
Last Update: The issue date and time of this CRL.
-
Next Update: The day and time by which the next CRL will be issued.
-
Revoked Certificates: List of revoked certificates. Each list item contains the following information.
-
Serial Number: The serial number, in hexadecimal format, of the revoked certificate.
-
Revocation Date: Date and time the certificate was revoked.
-
CRL Entry Extensions: Optional extensions for the CRL entry.
-
CRL Extensions: Optional extensions for the CRL.
-
Signature Algorithm: Algorithm used by your private CA to sign the CRL.
-
Signature Value: Signature computed over the CRL.
Certificate revocation lists created by ACM PCA are DER-encoded. You can use the following OpenSSL command to list a CRL.
openssl crl -inform DER -text -in crl_path -noout
"
- },
- "CsrBlob":{
- "type":"blob",
- "max":32768,
- "min":1
- },
- "CsrBody":{"type":"string"},
- "DeleteCertificateAuthorityRequest":{
- "type":"structure",
- "required":["CertificateAuthorityArn"],
- "members":{
- "CertificateAuthorityArn":{
- "shape":"Arn",
- "documentation":"The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
"
- },
- "PermanentDeletionTimeInDays":{
- "shape":"PermanentDeletionTimeInDays",
- "documentation":"The number of days to make a CA restorable after it has been deleted. This can be anywhere from 7 to 30 days, with 30 being the default.
"
- }
- }
- },
- "DescribeCertificateAuthorityAuditReportRequest":{
- "type":"structure",
- "required":[
- "CertificateAuthorityArn",
- "AuditReportId"
- ],
- "members":{
- "CertificateAuthorityArn":{
- "shape":"Arn",
- "documentation":"The Amazon Resource Name (ARN) of the private CA. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
"
- },
- "AuditReportId":{
- "shape":"AuditReportId",
- "documentation":"The report ID returned by calling the CreateCertificateAuthorityAuditReport operation.
"
- }
- }
- },
- "DescribeCertificateAuthorityAuditReportResponse":{
- "type":"structure",
- "members":{
- "AuditReportStatus":{
- "shape":"AuditReportStatus",
- "documentation":"Specifies whether report creation is in progress, has succeeded, or has failed.
"
- },
- "S3BucketName":{
- "shape":"String",
- "documentation":"Name of the S3 bucket that contains the report.
"
- },
- "S3Key":{
- "shape":"String",
- "documentation":"S3 key that uniquely identifies the report file in your S3 bucket.
"
- },
- "CreatedAt":{
- "shape":"TStamp",
- "documentation":"The date and time at which the report was created.
"
- }
- }
- },
- "DescribeCertificateAuthorityRequest":{
- "type":"structure",
- "required":["CertificateAuthorityArn"],
- "members":{
- "CertificateAuthorityArn":{
- "shape":"Arn",
- "documentation":"The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
"
- }
- }
- },
- "DescribeCertificateAuthorityResponse":{
- "type":"structure",
- "members":{
- "CertificateAuthority":{
- "shape":"CertificateAuthority",
- "documentation":"A CertificateAuthority structure that contains information about your private CA.
"
- }
- }
- },
- "DistinguishedNameQualifierString":{
- "type":"string",
- "max":64,
- "min":0,
- "pattern":"[a-zA-Z0-9'()+-.?:/= ]*"
- },
- "FailureReason":{
- "type":"string",
- "enum":[
- "REQUEST_TIMED_OUT",
- "UNSUPPORTED_ALGORITHM",
- "OTHER"
- ]
- },
- "GetCertificateAuthorityCertificateRequest":{
- "type":"structure",
- "required":["CertificateAuthorityArn"],
- "members":{
- "CertificateAuthorityArn":{
- "shape":"Arn",
- "documentation":"The Amazon Resource Name (ARN) of your private CA. This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
"
- }
- }
- },
- "GetCertificateAuthorityCertificateResponse":{
- "type":"structure",
- "members":{
- "Certificate":{
- "shape":"CertificateBody",
- "documentation":"Base64-encoded certificate authority (CA) certificate.
"
- },
- "CertificateChain":{
- "shape":"CertificateChain",
- "documentation":"Base64-encoded certificate chain that includes any intermediate certificates and chains up to root on-premises certificate that you used to sign your private CA certificate. The chain does not include your private CA certificate.
"
- }
- }
- },
- "GetCertificateAuthorityCsrRequest":{
- "type":"structure",
- "required":["CertificateAuthorityArn"],
- "members":{
- "CertificateAuthorityArn":{
- "shape":"Arn",
- "documentation":"The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority operation. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
"
- }
- }
- },
- "GetCertificateAuthorityCsrResponse":{
- "type":"structure",
- "members":{
- "Csr":{
- "shape":"CsrBody",
- "documentation":"The base64 PEM-encoded certificate signing request (CSR) for your private CA certificate.
"
- }
- }
- },
- "GetCertificateRequest":{
- "type":"structure",
- "required":[
- "CertificateAuthorityArn",
- "CertificateArn"
- ],
- "members":{
- "CertificateAuthorityArn":{
- "shape":"Arn",
- "documentation":"The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
"
- },
- "CertificateArn":{
- "shape":"Arn",
- "documentation":"The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
"
- }
- }
- },
- "GetCertificateResponse":{
- "type":"structure",
- "members":{
- "Certificate":{
- "shape":"CertificateBody",
- "documentation":"The base64 PEM-encoded certificate specified by the CertificateArn parameter.
"
- },
- "CertificateChain":{
- "shape":"CertificateChain",
- "documentation":"The base64 PEM-encoded certificate chain that chains up to the on-premises root CA certificate that you used to sign your private CA certificate.
"
- }
- }
- },
- "IdempotencyToken":{
- "type":"string",
- "max":36,
- "min":1,
- "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*"
- },
- "ImportCertificateAuthorityCertificateRequest":{
- "type":"structure",
- "required":[
- "CertificateAuthorityArn",
- "Certificate",
- "CertificateChain"
- ],
- "members":{
- "CertificateAuthorityArn":{
- "shape":"Arn",
- "documentation":"The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
"
- },
- "Certificate":{
- "shape":"CertificateBodyBlob",
- "documentation":"The PEM-encoded certificate for your private CA. This must be signed by using your on-premises CA.
"
- },
- "CertificateChain":{
- "shape":"CertificateChainBlob",
- "documentation":"A PEM-encoded file that contains all of your certificates, other than the certificate you're importing, chaining up to your root CA. Your on-premises root certificate is the last in the chain, and each certificate in the chain signs the one preceding.
"
- }
- }
- },
- "Integer1To5000":{
- "type":"integer",
- "max":5000,
- "min":1
- },
- "InvalidArgsException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"One or more of the specified arguments was not valid.
",
- "exception":true
- },
- "InvalidArnException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"The requested Amazon Resource Name (ARN) does not refer to an existing resource.
",
- "exception":true
- },
- "InvalidNextTokenException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"The token specified in the NextToken argument is not valid. Use the token returned from your previous call to ListCertificateAuthorities.
",
- "exception":true
- },
- "InvalidPolicyException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"The S3 bucket policy is not valid. The policy must give ACM PCA rights to read from and write to the bucket and find the bucket location.
",
- "exception":true
- },
- "InvalidStateException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"The private CA is in a state during which a report cannot be generated.
",
- "exception":true
- },
- "InvalidTagException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"The tag associated with the CA is not valid. The invalid argument is contained in the message field.
",
- "exception":true
- },
- "IssueCertificateRequest":{
- "type":"structure",
- "required":[
- "CertificateAuthorityArn",
- "Csr",
- "SigningAlgorithm",
- "Validity"
- ],
- "members":{
- "CertificateAuthorityArn":{
- "shape":"Arn",
- "documentation":"The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
"
- },
- "Csr":{
- "shape":"CsrBlob",
- "documentation":"The certificate signing request (CSR) for the certificate you want to issue. You can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.
openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
If you have a configuration file, you can use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.
openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
"
- },
- "SigningAlgorithm":{
- "shape":"SigningAlgorithm",
- "documentation":"The name of the algorithm that will be used to sign the certificate to be issued.
"
- },
- "Validity":{
- "shape":"Validity",
- "documentation":"The type of the validity period.
"
- },
- "IdempotencyToken":{
- "shape":"IdempotencyToken",
- "documentation":"Custom string that can be used to distinguish between calls to the IssueCertificate operation. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM PCA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.
"
- }
- }
- },
- "IssueCertificateResponse":{
- "type":"structure",
- "members":{
- "CertificateArn":{
- "shape":"Arn",
- "documentation":"The Amazon Resource Name (ARN) of the issued certificate and the certificate serial number. This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
"
- }
- }
- },
- "KeyAlgorithm":{
- "type":"string",
- "enum":[
- "RSA_2048",
- "RSA_4096",
- "EC_prime256v1",
- "EC_secp384r1"
- ]
- },
- "LimitExceededException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"An ACM PCA limit has been exceeded. See the exception message returned to determine the limit that was exceeded.
",
- "exception":true
- },
- "ListCertificateAuthoritiesRequest":{
- "type":"structure",
- "members":{
- "NextToken":{
- "shape":"NextToken",
- "documentation":"Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received.
"
- },
- "MaxResults":{
- "shape":"MaxResults",
- "documentation":"Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.
"
- }
- }
- },
- "ListCertificateAuthoritiesResponse":{
- "type":"structure",
- "members":{
- "CertificateAuthorities":{
- "shape":"CertificateAuthorities",
- "documentation":"Summary information about each certificate authority you have created.
"
- },
- "NextToken":{
- "shape":"NextToken",
- "documentation":"When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.
"
- }
- }
- },
- "ListTagsRequest":{
- "type":"structure",
- "required":["CertificateAuthorityArn"],
- "members":{
- "CertificateAuthorityArn":{
- "shape":"Arn",
- "documentation":"The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority operation. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
"
- },
- "NextToken":{
- "shape":"NextToken",
- "documentation":"Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.
"
- },
- "MaxResults":{
- "shape":"MaxResults",
- "documentation":"Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.
"
- }
- }
- },
- "ListTagsResponse":{
- "type":"structure",
- "members":{
- "Tags":{
- "shape":"TagList",
- "documentation":"The tags associated with your private CA.
"
- },
- "NextToken":{
- "shape":"NextToken",
- "documentation":"When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.
"
- }
- }
- },
- "MalformedCSRException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"The certificate signing request is invalid.
",
- "exception":true
- },
- "MalformedCertificateException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"One or more fields in the certificate are invalid.
",
- "exception":true
- },
- "MaxResults":{
- "type":"integer",
- "max":1000,
- "min":1
- },
- "NextToken":{
- "type":"string",
- "max":500,
- "min":1
- },
- "PermanentDeletionTimeInDays":{
- "type":"integer",
- "max":30,
- "min":7
- },
- "PositiveLong":{
- "type":"long",
- "min":1
- },
- "RequestAlreadyProcessedException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"Your request has already been completed.
",
- "exception":true
- },
- "RequestFailedException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"The request has failed for an unspecified reason.
",
- "exception":true
- },
- "RequestInProgressException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"Your request is already in progress.
",
- "exception":true
- },
- "ResourceNotFoundException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
",
- "exception":true
- },
- "RestoreCertificateAuthorityRequest":{
- "type":"structure",
- "required":["CertificateAuthorityArn"],
- "members":{
- "CertificateAuthorityArn":{
- "shape":"Arn",
- "documentation":"The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority operation. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
"
- }
- }
- },
- "RevocationConfiguration":{
- "type":"structure",
- "members":{
- "CrlConfiguration":{
- "shape":"CrlConfiguration",
- "documentation":"Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.
"
- }
- },
- "documentation":"Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority operations. Your private certificate authority (CA) can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates revoked by your CA. For more information, see RevokeCertificate.
"
- },
- "RevocationReason":{
- "type":"string",
- "enum":[
- "UNSPECIFIED",
- "KEY_COMPROMISE",
- "CERTIFICATE_AUTHORITY_COMPROMISE",
- "AFFILIATION_CHANGED",
- "SUPERSEDED",
- "CESSATION_OF_OPERATION",
- "PRIVILEGE_WITHDRAWN",
- "A_A_COMPROMISE"
- ]
- },
- "RevokeCertificateRequest":{
- "type":"structure",
- "required":[
- "CertificateAuthorityArn",
- "CertificateSerial",
- "RevocationReason"
- ],
- "members":{
- "CertificateAuthorityArn":{
- "shape":"Arn",
- "documentation":"Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
"
- },
- "CertificateSerial":{
- "shape":"String128",
- "documentation":"Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate operation retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.
openssl x509 -in file_path -text -noout
You can also copy the serial number from the console or use the DescribeCertificate operation in the AWS Certificate Manager API Reference.
"
- },
- "RevocationReason":{
- "shape":"RevocationReason",
- "documentation":"Specifies why you revoked the certificate.
"
- }
- }
- },
- "SigningAlgorithm":{
- "type":"string",
- "enum":[
- "SHA256WITHECDSA",
- "SHA384WITHECDSA",
- "SHA512WITHECDSA",
- "SHA256WITHRSA",
- "SHA384WITHRSA",
- "SHA512WITHRSA"
- ]
- },
- "String":{"type":"string"},
- "String128":{
- "type":"string",
- "max":128,
- "min":0
- },
- "String16":{
- "type":"string",
- "max":16,
- "min":0
- },
- "String253":{
- "type":"string",
- "max":253,
- "min":0
- },
- "String3":{
- "type":"string",
- "max":3,
- "min":0
- },
- "String3To255":{
- "type":"string",
- "max":255,
- "min":3
- },
- "String40":{
- "type":"string",
- "max":40,
- "min":0
- },
- "String5":{
- "type":"string",
- "max":5,
- "min":0
- },
- "String64":{
- "type":"string",
- "max":64,
- "min":0
- },
- "TStamp":{"type":"timestamp"},
- "Tag":{
- "type":"structure",
- "required":["Key"],
- "members":{
- "Key":{
- "shape":"TagKey",
- "documentation":"Key (name) of the tag.
"
- },
- "Value":{
- "shape":"TagValue",
- "documentation":"Value of the tag.
"
- }
- },
- "documentation":"Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority operation. To remove a tag, call the UntagCertificateAuthority operation.
"
- },
- "TagCertificateAuthorityRequest":{
- "type":"structure",
- "required":[
- "CertificateAuthorityArn",
- "Tags"
- ],
- "members":{
- "CertificateAuthorityArn":{
- "shape":"Arn",
- "documentation":"The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
"
- },
- "Tags":{
- "shape":"TagList",
- "documentation":"List of tags to be associated with the CA.
"
- }
- }
- },
- "TagKey":{
- "type":"string",
- "max":128,
- "min":1,
- "pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*"
- },
- "TagList":{
- "type":"list",
- "member":{"shape":"Tag"},
- "max":50,
- "min":1
- },
- "TagValue":{
- "type":"string",
- "max":256,
- "min":0,
- "pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*"
- },
- "TooManyTagsException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"You can associate up to 50 tags with a private CA. Exception information is contained in the exception message field.
",
- "exception":true
- },
- "UntagCertificateAuthorityRequest":{
- "type":"structure",
- "required":[
- "CertificateAuthorityArn",
- "Tags"
- ],
- "members":{
- "CertificateAuthorityArn":{
- "shape":"Arn",
- "documentation":"The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
"
- },
- "Tags":{
- "shape":"TagList",
- "documentation":"List of tags to be removed from the CA.
"
- }
- }
- },
- "UpdateCertificateAuthorityRequest":{
- "type":"structure",
- "required":["CertificateAuthorityArn"],
- "members":{
- "CertificateAuthorityArn":{
- "shape":"Arn",
- "documentation":"Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
"
- },
- "RevocationConfiguration":{
- "shape":"RevocationConfiguration",
- "documentation":"Revocation information for your private CA.
"
- },
- "Status":{
- "shape":"CertificateAuthorityStatus",
- "documentation":"Status of your private CA.
"
- }
- }
- },
- "Validity":{
- "type":"structure",
- "required":[
- "Value",
- "Type"
- ],
- "members":{
- "Value":{
- "shape":"PositiveLong",
- "documentation":"Time period.
",
- "box":true
- },
- "Type":{
- "shape":"ValidityPeriodType",
- "documentation":"Specifies whether the Value parameter represents days, months, or years.
"
- }
- },
- "documentation":"Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years. You can issue a certificate by calling the IssueCertificate operation.
"
- },
- "ValidityPeriodType":{
- "type":"string",
- "enum":[
- "END_DATE",
- "ABSOLUTE",
- "DAYS",
- "MONTHS",
- "YEARS"
- ]
- }
- },
- "documentation":"You can use the ACM PCA API to create a private certificate authority (CA). You must first call the CreateCertificateAuthority operation. If successful, the operation returns an Amazon Resource Name (ARN) for your private CA. Use this ARN as input to the GetCertificateAuthorityCsr operation to retrieve the certificate signing request (CSR) for your private CA certificate. Sign the CSR using the root or an intermediate CA in your on-premises PKI hierarchy, and call the ImportCertificateAuthorityCertificate to import your signed private CA certificate into ACM PCA.
Use your private CA to issue and revoke certificates. These are private certificates that identify and secure client computers, servers, applications, services, devices, and users over SSLS/TLS connections within your organization. Call the IssueCertificate operation to issue a certificate. Call the RevokeCertificate operation to revoke a certificate.
Certificates issued by your private CA can be trusted only within your organization, not publicly.
Your private CA can optionally create a certificate revocation list (CRL) to track the certificates you revoke. To create a CRL, you must specify a RevocationConfiguration object when you call the CreateCertificateAuthority operation. ACM PCA writes the CRL to an S3 bucket that you specify. You must specify a bucket policy that grants ACM PCA write permission.
You can also call the CreateCertificateAuthorityAuditReport to create an optional audit report that lists every time the CA private key is used. The private key is used for signing when the IssueCertificate or RevokeCertificate operation is called.
"
-}
diff --git a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/acm/2015-12-08/examples-1.json b/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/acm/2015-12-08/examples-1.json
deleted file mode 100644
index 0ea7e3b0..00000000
--- a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/acm/2015-12-08/examples-1.json
+++ /dev/null
@@ -1,5 +0,0 @@
-{
- "version": "1.0",
- "examples": {
- }
-}
diff --git a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/acm/2015-12-08/paginators-1.json b/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/acm/2015-12-08/paginators-1.json
deleted file mode 100644
index 2e2e4f9a..00000000
--- a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/acm/2015-12-08/paginators-1.json
+++ /dev/null
@@ -1,10 +0,0 @@
-{
- "pagination": {
- "ListCertificates": {
- "input_token": "NextToken",
- "output_token": "NextToken",
- "limit_key": "MaxItems",
- "result_key": "CertificateSummaryList"
- }
- }
-}
diff --git a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/acm/2015-12-08/service-2.json b/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/acm/2015-12-08/service-2.json
deleted file mode 100644
index 5845ed9e..00000000
--- a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/acm/2015-12-08/service-2.json
+++ /dev/null
@@ -1,1114 +0,0 @@
-{
- "version":"2.0",
- "metadata":{
- "apiVersion":"2015-12-08",
- "endpointPrefix":"acm",
- "jsonVersion":"1.1",
- "protocol":"json",
- "serviceAbbreviation":"ACM",
- "serviceFullName":"AWS Certificate Manager",
- "serviceId":"ACM",
- "signatureVersion":"v4",
- "targetPrefix":"CertificateManager",
- "uid":"acm-2015-12-08"
- },
- "operations":{
- "AddTagsToCertificate":{
- "name":"AddTagsToCertificate",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"AddTagsToCertificateRequest"},
- "errors":[
- {"shape":"ResourceNotFoundException"},
- {"shape":"InvalidArnException"},
- {"shape":"InvalidTagException"},
- {"shape":"TooManyTagsException"}
- ],
- "documentation":"Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair.
You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates.
To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.
"
- },
- "DeleteCertificate":{
- "name":"DeleteCertificate",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"DeleteCertificateRequest"},
- "errors":[
- {"shape":"ResourceNotFoundException"},
- {"shape":"ResourceInUseException"},
- {"shape":"InvalidArnException"}
- ],
- "documentation":"Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by AWS services integrated with ACM.
You cannot delete an ACM certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.
"
- },
- "DescribeCertificate":{
- "name":"DescribeCertificate",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"DescribeCertificateRequest"},
- "output":{"shape":"DescribeCertificateResponse"},
- "errors":[
- {"shape":"ResourceNotFoundException"},
- {"shape":"InvalidArnException"}
- ],
- "documentation":"Returns detailed metadata about the specified ACM certificate.
"
- },
- "ExportCertificate":{
- "name":"ExportCertificate",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"ExportCertificateRequest"},
- "output":{"shape":"ExportCertificateResponse"},
- "errors":[
- {"shape":"ResourceNotFoundException"},
- {"shape":"RequestInProgressException"},
- {"shape":"InvalidArnException"}
- ],
- "documentation":"Exports a private certificate issued by a private certificate authority (CA) for use anywhere. You can export the certificate, the certificate chain, and the encrypted private key associated with the public key embedded in the certificate. You must store the private key securely. The private key is a 2048 bit RSA key. You must provide a passphrase for the private key when exporting it. You can use the following OpenSSL command to decrypt it later. Provide the passphrase when prompted.
openssl rsa -in encrypted_key.pem -out decrypted_key.pem
"
- },
- "GetCertificate":{
- "name":"GetCertificate",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"GetCertificateRequest"},
- "output":{"shape":"GetCertificateResponse"},
- "errors":[
- {"shape":"ResourceNotFoundException"},
- {"shape":"RequestInProgressException"},
- {"shape":"InvalidArnException"}
- ],
- "documentation":"Retrieves a certificate specified by an ARN and its certificate chain . The chain is an ordered list of certificates that contains the end entity certificate, intermediate certificates of subordinate CAs, and the root certificate in that order. The certificate and certificate chain are base64 encoded. If you want to decode the certificate to see the individual fields, you can use OpenSSL.
"
- },
- "ImportCertificate":{
- "name":"ImportCertificate",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"ImportCertificateRequest"},
- "output":{"shape":"ImportCertificateResponse"},
- "errors":[
- {"shape":"ResourceNotFoundException"},
- {"shape":"LimitExceededException"}
- ],
- "documentation":"Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the AWS Certificate Manager User Guide.
ACM does not provide managed renewal for certificates that you import.
Note the following guidelines when importing third party certificates:
-
You must enter the private key that matches the certificate you are importing.
-
The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.
-
If the certificate you are importing is not self-signed, you must enter its certificate chain.
-
If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.
-
The certificate, private key, and certificate chain must be PEM-encoded.
-
The current time must be between the Not Before and Not After certificate fields.
-
The Issuer field must not be empty.
-
The OCSP authority URL, if present, must not exceed 1000 characters.
-
To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certificate.
-
When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by file://. For example, you can specify a certificate saved in the C:\\temp folder as file://C:\\temp\\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs.
-
When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using.
This operation returns the Amazon Resource Name (ARN) of the imported certificate.
"
- },
- "ListCertificates":{
- "name":"ListCertificates",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"ListCertificatesRequest"},
- "output":{"shape":"ListCertificatesResponse"},
- "documentation":"Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate.
"
- },
- "ListTagsForCertificate":{
- "name":"ListTagsForCertificate",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"ListTagsForCertificateRequest"},
- "output":{"shape":"ListTagsForCertificateResponse"},
- "errors":[
- {"shape":"ResourceNotFoundException"},
- {"shape":"InvalidArnException"}
- ],
- "documentation":"Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.
"
- },
- "RemoveTagsFromCertificate":{
- "name":"RemoveTagsFromCertificate",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"RemoveTagsFromCertificateRequest"},
- "errors":[
- {"shape":"ResourceNotFoundException"},
- {"shape":"InvalidArnException"},
- {"shape":"InvalidTagException"}
- ],
- "documentation":"Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value.
To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.
"
- },
- "RequestCertificate":{
- "name":"RequestCertificate",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"RequestCertificateRequest"},
- "output":{"shape":"RequestCertificateResponse"},
- "errors":[
- {"shape":"LimitExceededException"},
- {"shape":"InvalidDomainValidationOptionsException"},
- {"shape":"InvalidArnException"}
- ],
- "documentation":"Requests an ACM certificate for use with other AWS services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter.
If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner.
"
- },
- "ResendValidationEmail":{
- "name":"ResendValidationEmail",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"ResendValidationEmailRequest"},
- "errors":[
- {"shape":"ResourceNotFoundException"},
- {"shape":"InvalidStateException"},
- {"shape":"InvalidArnException"},
- {"shape":"InvalidDomainValidationOptionsException"}
- ],
- "documentation":"Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see Configure Email for your Domain.
"
- },
- "UpdateCertificateOptions":{
- "name":"UpdateCertificateOptions",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"UpdateCertificateOptionsRequest"},
- "errors":[
- {"shape":"ResourceNotFoundException"},
- {"shape":"LimitExceededException"},
- {"shape":"InvalidStateException"},
- {"shape":"InvalidArnException"}
- ],
- "documentation":"Updates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see Opting Out of Certificate Transparency Logging.
"
- }
- },
- "shapes":{
- "AddTagsToCertificateRequest":{
- "type":"structure",
- "required":[
- "CertificateArn",
- "Tags"
- ],
- "members":{
- "CertificateArn":{
- "shape":"Arn",
- "documentation":"String that contains the ARN of the ACM certificate to which the tag is to be applied. This must be of the form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
"
- },
- "Tags":{
- "shape":"TagList",
- "documentation":"The key-value pair that defines the tag. The tag value is optional.
"
- }
- }
- },
- "Arn":{
- "type":"string",
- "max":2048,
- "min":20,
- "pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*"
- },
- "CertificateBody":{
- "type":"string",
- "max":32768,
- "min":1,
- "pattern":"-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?"
- },
- "CertificateBodyBlob":{
- "type":"blob",
- "max":32768,
- "min":1
- },
- "CertificateChain":{
- "type":"string",
- "max":2097152,
- "min":1,
- "pattern":"(-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}\\u000D?\\u000A)*-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?"
- },
- "CertificateChainBlob":{
- "type":"blob",
- "max":2097152,
- "min":1
- },
- "CertificateDetail":{
- "type":"structure",
- "members":{
- "CertificateArn":{
- "shape":"Arn",
- "documentation":"The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
"
- },
- "DomainName":{
- "shape":"DomainNameString",
- "documentation":"The fully qualified domain name for the certificate, such as www.example.com or example.com.
"
- },
- "SubjectAlternativeNames":{
- "shape":"DomainList",
- "documentation":"One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.
"
- },
- "DomainValidationOptions":{
- "shape":"DomainValidationList",
- "documentation":"Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.
"
- },
- "Serial":{
- "shape":"String",
- "documentation":"The serial number of the certificate.
"
- },
- "Subject":{
- "shape":"String",
- "documentation":"The name of the entity that is associated with the public key contained in the certificate.
"
- },
- "Issuer":{
- "shape":"String",
- "documentation":"The name of the certificate authority that issued and signed the certificate.
"
- },
- "CreatedAt":{
- "shape":"TStamp",
- "documentation":"The time at which the certificate was requested. This value exists only when the certificate type is AMAZON_ISSUED.
"
- },
- "IssuedAt":{
- "shape":"TStamp",
- "documentation":"The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.
"
- },
- "ImportedAt":{
- "shape":"TStamp",
- "documentation":"The date and time at which the certificate was imported. This value exists only when the certificate type is IMPORTED.
"
- },
- "Status":{
- "shape":"CertificateStatus",
- "documentation":"The status of the certificate.
"
- },
- "RevokedAt":{
- "shape":"TStamp",
- "documentation":"The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.
"
- },
- "RevocationReason":{
- "shape":"RevocationReason",
- "documentation":"The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.
"
- },
- "NotBefore":{
- "shape":"TStamp",
- "documentation":"The time before which the certificate is not valid.
"
- },
- "NotAfter":{
- "shape":"TStamp",
- "documentation":"The time after which the certificate is not valid.
"
- },
- "KeyAlgorithm":{
- "shape":"KeyAlgorithm",
- "documentation":"The algorithm that was used to generate the public-private key pair.
"
- },
- "SignatureAlgorithm":{
- "shape":"String",
- "documentation":"The algorithm that was used to sign the certificate.
"
- },
- "InUseBy":{
- "shape":"InUseList",
- "documentation":"A list of ARNs for the AWS resources that are using the certificate. A certificate can be used by multiple AWS resources.
"
- },
- "FailureReason":{
- "shape":"FailureReason",
- "documentation":"The reason the certificate request failed. This value exists only when the certificate status is FAILED. For more information, see Certificate Request Failed in the AWS Certificate Manager User Guide.
"
- },
- "Type":{
- "shape":"CertificateType",
- "documentation":"The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the AWS Certificate Manager User Guide.
"
- },
- "RenewalSummary":{
- "shape":"RenewalSummary",
- "documentation":"Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.
"
- },
- "KeyUsages":{
- "shape":"KeyUsageList",
- "documentation":"A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.
"
- },
- "ExtendedKeyUsages":{
- "shape":"ExtendedKeyUsageList",
- "documentation":"Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).
"
- },
- "CertificateAuthorityArn":{
- "shape":"Arn",
- "documentation":"The Amazon Resource Name (ARN) of the ACM PCA private certificate authority (CA) that issued the certificate. This has the following format:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
"
- },
- "RenewalEligibility":{
- "shape":"RenewalEligibility",
- "documentation":"Specifies whether the certificate is eligible for renewal.
"
- },
- "Options":{
- "shape":"CertificateOptions",
- "documentation":"Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure.
"
- }
- },
- "documentation":"Contains metadata about an ACM certificate. This structure is returned in the response to a DescribeCertificate request.
"
- },
- "CertificateOptions":{
- "type":"structure",
- "members":{
- "CertificateTransparencyLoggingPreference":{
- "shape":"CertificateTransparencyLoggingPreference",
- "documentation":"You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED.
"
- }
- },
- "documentation":"Structure that contains options for your certificate. Currently, you can use this only to specify whether to opt in to or out of certificate transparency logging. Some browsers require that public certificates issued for your domain be recorded in a log. Certificates that are not logged typically generate a browser error. Transparency makes it possible for you to detect SSL/TLS certificates that have been mistakenly or maliciously issued for your domain. For general information, see Certificate Transparency Logging.
"
- },
- "CertificateStatus":{
- "type":"string",
- "enum":[
- "PENDING_VALIDATION",
- "ISSUED",
- "INACTIVE",
- "EXPIRED",
- "VALIDATION_TIMED_OUT",
- "REVOKED",
- "FAILED"
- ]
- },
- "CertificateStatuses":{
- "type":"list",
- "member":{"shape":"CertificateStatus"}
- },
- "CertificateSummary":{
- "type":"structure",
- "members":{
- "CertificateArn":{
- "shape":"Arn",
- "documentation":"Amazon Resource Name (ARN) of the certificate. This is of the form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
"
- },
- "DomainName":{
- "shape":"DomainNameString",
- "documentation":"Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.
"
- }
- },
- "documentation":"This structure is returned in the response object of ListCertificates action.
"
- },
- "CertificateSummaryList":{
- "type":"list",
- "member":{"shape":"CertificateSummary"}
- },
- "CertificateTransparencyLoggingPreference":{
- "type":"string",
- "enum":[
- "ENABLED",
- "DISABLED"
- ]
- },
- "CertificateType":{
- "type":"string",
- "enum":[
- "IMPORTED",
- "AMAZON_ISSUED",
- "PRIVATE"
- ]
- },
- "DeleteCertificateRequest":{
- "type":"structure",
- "required":["CertificateArn"],
- "members":{
- "CertificateArn":{
- "shape":"Arn",
- "documentation":"String that contains the ARN of the ACM certificate to be deleted. This must be of the form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
"
- }
- }
- },
- "DescribeCertificateRequest":{
- "type":"structure",
- "required":["CertificateArn"],
- "members":{
- "CertificateArn":{
- "shape":"Arn",
- "documentation":"The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
"
- }
- }
- },
- "DescribeCertificateResponse":{
- "type":"structure",
- "members":{
- "Certificate":{
- "shape":"CertificateDetail",
- "documentation":"Metadata about an ACM certificate.
"
- }
- }
- },
- "DomainList":{
- "type":"list",
- "member":{"shape":"DomainNameString"},
- "max":100,
- "min":1
- },
- "DomainNameString":{
- "type":"string",
- "max":253,
- "min":1,
- "pattern":"^(\\*\\.)?(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$"
- },
- "DomainStatus":{
- "type":"string",
- "enum":[
- "PENDING_VALIDATION",
- "SUCCESS",
- "FAILED"
- ]
- },
- "DomainValidation":{
- "type":"structure",
- "required":["DomainName"],
- "members":{
- "DomainName":{
- "shape":"DomainNameString",
- "documentation":"A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com.
"
- },
- "ValidationEmails":{
- "shape":"ValidationEmailList",
- "documentation":"A list of email addresses that ACM used to send domain validation emails.
"
- },
- "ValidationDomain":{
- "shape":"DomainNameString",
- "documentation":"The domain name that ACM used to send domain validation emails.
"
- },
- "ValidationStatus":{
- "shape":"DomainStatus",
- "documentation":"The validation status of the domain name. This can be one of the following values:
-
PENDING_VALIDATION
-
-
"
- },
- "ResourceRecord":{
- "shape":"ResourceRecord",
- "documentation":"Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership.
"
- },
- "ValidationMethod":{
- "shape":"ValidationMethod",
- "documentation":"Specifies the domain validation method.
"
- }
- },
- "documentation":"Contains information about the validation of each domain name in the certificate.
"
- },
- "DomainValidationList":{
- "type":"list",
- "member":{"shape":"DomainValidation"},
- "max":1000,
- "min":1
- },
- "DomainValidationOption":{
- "type":"structure",
- "required":[
- "DomainName",
- "ValidationDomain"
- ],
- "members":{
- "DomainName":{
- "shape":"DomainNameString",
- "documentation":"A fully qualified domain name (FQDN) in the certificate request.
"
- },
- "ValidationDomain":{
- "shape":"DomainNameString",
- "documentation":"The domain name that you want ACM to use to send you validation emails. This domain name is the suffix of the email addresses that you want ACM to use. This must be the same as the DomainName value or a superdomain of the DomainName value. For example, if you request a certificate for testing.example.com, you can specify example.com for this value. In that case, ACM sends domain validation emails to the following five addresses:
"
- }
- },
- "documentation":"Contains information about the domain names that you want ACM to use to send you emails that enable you to validate domain ownership.
"
- },
- "DomainValidationOptionList":{
- "type":"list",
- "member":{"shape":"DomainValidationOption"},
- "max":100,
- "min":1
- },
- "ExportCertificateRequest":{
- "type":"structure",
- "required":[
- "CertificateArn",
- "Passphrase"
- ],
- "members":{
- "CertificateArn":{
- "shape":"Arn",
- "documentation":"An Amazon Resource Name (ARN) of the issued certificate. This must be of the form:
arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012
"
- },
- "Passphrase":{
- "shape":"PassphraseBlob",
- "documentation":"Passphrase to associate with the encrypted exported private key. If you want to later decrypt the private key, you must have the passphrase. You can use the following OpenSSL command to decrypt a private key:
openssl rsa -in encrypted_key.pem -out decrypted_key.pem
"
- }
- }
- },
- "ExportCertificateResponse":{
- "type":"structure",
- "members":{
- "Certificate":{
- "shape":"CertificateBody",
- "documentation":"The base64 PEM-encoded certificate.
"
- },
- "CertificateChain":{
- "shape":"CertificateChain",
- "documentation":"The base64 PEM-encoded certificate chain. This does not include the certificate that you are exporting.
"
- },
- "PrivateKey":{
- "shape":"PrivateKey",
- "documentation":"The PEM-encoded private key associated with the public key in the certificate.
"
- }
- }
- },
- "ExtendedKeyUsage":{
- "type":"structure",
- "members":{
- "Name":{
- "shape":"ExtendedKeyUsageName",
- "documentation":"The name of an Extended Key Usage value.
"
- },
- "OID":{
- "shape":"String",
- "documentation":"An object identifier (OID) for the extension value. OIDs are strings of numbers separated by periods. The following OIDs are defined in RFC 3280 and RFC 5280.
-
1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION)
-
1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION)
-
1.3.6.1.5.5.7.3.3 (CODE_SIGNING)
-
1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION)
-
1.3.6.1.5.5.7.3.8 (TIME_STAMPING)
-
1.3.6.1.5.5.7.3.9 (OCSP_SIGNING)
-
1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM)
-
1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL)
-
1.3.6.1.5.5.7.3.7 (IPSEC_USER)
"
- }
- },
- "documentation":"The Extended Key Usage X.509 v3 extension defines one or more purposes for which the public key can be used. This is in addition to or in place of the basic purposes specified by the Key Usage extension.
"
- },
- "ExtendedKeyUsageFilterList":{
- "type":"list",
- "member":{"shape":"ExtendedKeyUsageName"}
- },
- "ExtendedKeyUsageList":{
- "type":"list",
- "member":{"shape":"ExtendedKeyUsage"}
- },
- "ExtendedKeyUsageName":{
- "type":"string",
- "enum":[
- "TLS_WEB_SERVER_AUTHENTICATION",
- "TLS_WEB_CLIENT_AUTHENTICATION",
- "CODE_SIGNING",
- "EMAIL_PROTECTION",
- "TIME_STAMPING",
- "OCSP_SIGNING",
- "IPSEC_END_SYSTEM",
- "IPSEC_TUNNEL",
- "IPSEC_USER",
- "ANY",
- "NONE",
- "CUSTOM"
- ]
- },
- "FailureReason":{
- "type":"string",
- "enum":[
- "NO_AVAILABLE_CONTACTS",
- "ADDITIONAL_VERIFICATION_REQUIRED",
- "DOMAIN_NOT_ALLOWED",
- "INVALID_PUBLIC_DOMAIN",
- "CAA_ERROR",
- "PCA_LIMIT_EXCEEDED",
- "PCA_INVALID_ARN",
- "PCA_INVALID_STATE",
- "PCA_REQUEST_FAILED",
- "PCA_RESOURCE_NOT_FOUND",
- "PCA_INVALID_ARGS",
- "OTHER"
- ]
- },
- "Filters":{
- "type":"structure",
- "members":{
- "extendedKeyUsage":{
- "shape":"ExtendedKeyUsageFilterList",
- "documentation":"Specify one or more ExtendedKeyUsage extension values.
"
- },
- "keyUsage":{
- "shape":"KeyUsageFilterList",
- "documentation":"Specify one or more KeyUsage extension values.
"
- },
- "keyTypes":{
- "shape":"KeyAlgorithmList",
- "documentation":"Specify one or more algorithms that can be used to generate key pairs.
"
- }
- },
- "documentation":"This structure can be used in the ListCertificates action to filter the output of the certificate list.
"
- },
- "GetCertificateRequest":{
- "type":"structure",
- "required":["CertificateArn"],
- "members":{
- "CertificateArn":{
- "shape":"Arn",
- "documentation":"String that contains a certificate ARN in the following format:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
"
- }
- }
- },
- "GetCertificateResponse":{
- "type":"structure",
- "members":{
- "Certificate":{
- "shape":"CertificateBody",
- "documentation":"String that contains the ACM certificate represented by the ARN specified at input.
"
- },
- "CertificateChain":{
- "shape":"CertificateChain",
- "documentation":"The certificate chain that contains the root certificate issued by the certificate authority (CA).
"
- }
- }
- },
- "IdempotencyToken":{
- "type":"string",
- "max":32,
- "min":1,
- "pattern":"\\w+"
- },
- "ImportCertificateRequest":{
- "type":"structure",
- "required":[
- "Certificate",
- "PrivateKey"
- ],
- "members":{
- "CertificateArn":{
- "shape":"Arn",
- "documentation":"The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field.
"
- },
- "Certificate":{
- "shape":"CertificateBodyBlob",
- "documentation":"The certificate to import.
"
- },
- "PrivateKey":{
- "shape":"PrivateKeyBlob",
- "documentation":"The private key that matches the public key in the certificate.
"
- },
- "CertificateChain":{
- "shape":"CertificateChainBlob",
- "documentation":"The PEM encoded certificate chain.
"
- }
- }
- },
- "ImportCertificateResponse":{
- "type":"structure",
- "members":{
- "CertificateArn":{
- "shape":"Arn",
- "documentation":"The Amazon Resource Name (ARN) of the imported certificate.
"
- }
- }
- },
- "InUseList":{
- "type":"list",
- "member":{"shape":"String"}
- },
- "InvalidArnException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"The requested Amazon Resource Name (ARN) does not refer to an existing resource.
",
- "exception":true
- },
- "InvalidDomainValidationOptionsException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"One or more values in the DomainValidationOption structure is incorrect.
",
- "exception":true
- },
- "InvalidStateException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"Processing has reached an invalid state.
",
- "exception":true
- },
- "InvalidTagException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"One or both of the values that make up the key-value pair is not valid. For example, you cannot specify a tag value that begins with aws:.
",
- "exception":true
- },
- "KeyAlgorithm":{
- "type":"string",
- "enum":[
- "RSA_2048",
- "RSA_1024",
- "RSA_4096",
- "EC_prime256v1",
- "EC_secp384r1",
- "EC_secp521r1"
- ]
- },
- "KeyAlgorithmList":{
- "type":"list",
- "member":{"shape":"KeyAlgorithm"}
- },
- "KeyUsage":{
- "type":"structure",
- "members":{
- "Name":{
- "shape":"KeyUsageName",
- "documentation":"A string value that contains a Key Usage extension name.
"
- }
- },
- "documentation":"The Key Usage X.509 v3 extension defines the purpose of the public key contained in the certificate.
"
- },
- "KeyUsageFilterList":{
- "type":"list",
- "member":{"shape":"KeyUsageName"}
- },
- "KeyUsageList":{
- "type":"list",
- "member":{"shape":"KeyUsage"}
- },
- "KeyUsageName":{
- "type":"string",
- "enum":[
- "DIGITAL_SIGNATURE",
- "NON_REPUDIATION",
- "KEY_ENCIPHERMENT",
- "DATA_ENCIPHERMENT",
- "KEY_AGREEMENT",
- "CERTIFICATE_SIGNING",
- "CRL_SIGNING",
- "ENCIPHER_ONLY",
- "DECIPHER_ONLY",
- "ANY",
- "CUSTOM"
- ]
- },
- "LimitExceededException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"An ACM limit has been exceeded.
",
- "exception":true
- },
- "ListCertificatesRequest":{
- "type":"structure",
- "members":{
- "CertificateStatuses":{
- "shape":"CertificateStatuses",
- "documentation":"Filter the certificate list by status value.
"
- },
- "Includes":{
- "shape":"Filters",
- "documentation":"Filter the certificate list. For more information, see the Filters structure.
"
- },
- "NextToken":{
- "shape":"NextToken",
- "documentation":"Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.
"
- },
- "MaxItems":{
- "shape":"MaxItems",
- "documentation":"Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.
"
- }
- }
- },
- "ListCertificatesResponse":{
- "type":"structure",
- "members":{
- "NextToken":{
- "shape":"NextToken",
- "documentation":"When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request.
"
- },
- "CertificateSummaryList":{
- "shape":"CertificateSummaryList",
- "documentation":"A list of ACM certificates.
"
- }
- }
- },
- "ListTagsForCertificateRequest":{
- "type":"structure",
- "required":["CertificateArn"],
- "members":{
- "CertificateArn":{
- "shape":"Arn",
- "documentation":"String that contains the ARN of the ACM certificate for which you want to list the tags. This must have the following form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
"
- }
- }
- },
- "ListTagsForCertificateResponse":{
- "type":"structure",
- "members":{
- "Tags":{
- "shape":"TagList",
- "documentation":"The key-value pairs that define the applied tags.
"
- }
- }
- },
- "MaxItems":{
- "type":"integer",
- "max":1000,
- "min":1
- },
- "NextToken":{
- "type":"string",
- "max":320,
- "min":1,
- "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*"
- },
- "PassphraseBlob":{
- "type":"blob",
- "max":128,
- "min":4,
- "sensitive":true
- },
- "PrivateKey":{
- "type":"string",
- "max":524288,
- "min":1,
- "pattern":"-{5}BEGIN PRIVATE KEY-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END PRIVATE KEY-{5}(\\u000D?\\u000A)?",
- "sensitive":true
- },
- "PrivateKeyBlob":{
- "type":"blob",
- "max":524288,
- "min":1,
- "sensitive":true
- },
- "RecordType":{
- "type":"string",
- "enum":["CNAME"]
- },
- "RemoveTagsFromCertificateRequest":{
- "type":"structure",
- "required":[
- "CertificateArn",
- "Tags"
- ],
- "members":{
- "CertificateArn":{
- "shape":"Arn",
- "documentation":"String that contains the ARN of the ACM Certificate with one or more tags that you want to remove. This must be of the form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
"
- },
- "Tags":{
- "shape":"TagList",
- "documentation":"The key-value pair that defines the tag to remove.
"
- }
- }
- },
- "RenewalEligibility":{
- "type":"string",
- "enum":[
- "ELIGIBLE",
- "INELIGIBLE"
- ]
- },
- "RenewalStatus":{
- "type":"string",
- "enum":[
- "PENDING_AUTO_RENEWAL",
- "PENDING_VALIDATION",
- "SUCCESS",
- "FAILED"
- ]
- },
- "RenewalSummary":{
- "type":"structure",
- "required":[
- "RenewalStatus",
- "DomainValidationOptions"
- ],
- "members":{
- "RenewalStatus":{
- "shape":"RenewalStatus",
- "documentation":"The status of ACM's managed renewal of the certificate.
"
- },
- "DomainValidationOptions":{
- "shape":"DomainValidationList",
- "documentation":"Contains information about the validation of each domain name in the certificate, as it pertains to ACM's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.
"
- }
- },
- "documentation":"Contains information about the status of ACM's managed renewal for the certificate. This structure exists only when the certificate type is AMAZON_ISSUED.
"
- },
- "RequestCertificateRequest":{
- "type":"structure",
- "required":["DomainName"],
- "members":{
- "DomainName":{
- "shape":"DomainNameString",
- "documentation":" Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com.
The first domain name you enter cannot exceed 63 octets, including periods. Each subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length.
"
- },
- "ValidationMethod":{
- "shape":"ValidationMethod",
- "documentation":"The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation.
"
- },
- "SubjectAlternativeNames":{
- "shape":"DomainList",
- "documentation":"Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial limit is 10 domain names. If you need more than 10 names, you must request a limit increase. For more information, see Limits.
The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples:
-
(63 octets).(63 octets).(63 octets).(61 octets) is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.
-
(64 octets).(63 octets).(63 octets).(61 octets) is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.
-
(63 octets).(63 octets).(63 octets).(62 octets) is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.
"
- },
- "IdempotencyToken":{
- "shape":"IdempotencyToken",
- "documentation":"Customer chosen string that can be used to distinguish between calls to RequestCertificate. Idempotency tokens time out after one hour. Therefore, if you call RequestCertificate multiple times with the same idempotency token within one hour, ACM recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, ACM recognizes that you are requesting multiple certificates.
"
- },
- "DomainValidationOptions":{
- "shape":"DomainValidationOptionList",
- "documentation":"The domain name that you want ACM to use to send you emails so that you can validate domain ownership.
"
- },
- "Options":{
- "shape":"CertificateOptions",
- "documentation":"Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see Opting Out of Certificate Transparency Logging.
"
- },
- "CertificateAuthorityArn":{
- "shape":"Arn",
- "documentation":"The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the AWS Certificate Manager Private Certificate Authority (PCA) user guide. The ARN must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
"
- }
- }
- },
- "RequestCertificateResponse":{
- "type":"structure",
- "members":{
- "CertificateArn":{
- "shape":"Arn",
- "documentation":"String that contains the ARN of the issued certificate. This must be of the form:
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
"
- }
- }
- },
- "RequestInProgressException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"The certificate request is in process and the certificate in your account has not yet been issued.
",
- "exception":true
- },
- "ResendValidationEmailRequest":{
- "type":"structure",
- "required":[
- "CertificateArn",
- "Domain",
- "ValidationDomain"
- ],
- "members":{
- "CertificateArn":{
- "shape":"Arn",
- "documentation":"String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by the RequestCertificate action as soon as the request is made. By default, using this parameter causes email to be sent to all top-level domains you specified in the certificate request. The ARN must be of the form:
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
"
- },
- "Domain":{
- "shape":"DomainNameString",
- "documentation":"The fully qualified domain name (FQDN) of the certificate that needs to be validated.
"
- },
- "ValidationDomain":{
- "shape":"DomainNameString",
- "documentation":"The base validation domain that will act as the suffix of the email addresses that are used to send the emails. This must be the same as the Domain value or a superdomain of the Domain value. For example, if you requested a certificate for site.subdomain.example.com and specify a ValidationDomain of subdomain.example.com, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses:
-
admin@subdomain.example.com
-
administrator@subdomain.example.com
-
hostmaster@subdomain.example.com
-
postmaster@subdomain.example.com
-
webmaster@subdomain.example.com
"
- }
- }
- },
- "ResourceInUseException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"The certificate is in use by another AWS service in the caller's account. Remove the association and try again.
",
- "exception":true
- },
- "ResourceNotFoundException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"The specified certificate cannot be found in the caller's account or the caller's account cannot be found.
",
- "exception":true
- },
- "ResourceRecord":{
- "type":"structure",
- "required":[
- "Name",
- "Type",
- "Value"
- ],
- "members":{
- "Name":{
- "shape":"String",
- "documentation":"The name of the DNS record to create in your domain. This is supplied by ACM.
"
- },
- "Type":{
- "shape":"RecordType",
- "documentation":"The type of DNS record. Currently this can be CNAME.
"
- },
- "Value":{
- "shape":"String",
- "documentation":"The value of the CNAME record to add to your DNS database. This is supplied by ACM.
"
- }
- },
- "documentation":"Contains a DNS record value that you can use to can use to validate ownership or control of a domain. This is used by the DescribeCertificate action.
"
- },
- "RevocationReason":{
- "type":"string",
- "enum":[
- "UNSPECIFIED",
- "KEY_COMPROMISE",
- "CA_COMPROMISE",
- "AFFILIATION_CHANGED",
- "SUPERCEDED",
- "CESSATION_OF_OPERATION",
- "CERTIFICATE_HOLD",
- "REMOVE_FROM_CRL",
- "PRIVILEGE_WITHDRAWN",
- "A_A_COMPROMISE"
- ]
- },
- "String":{"type":"string"},
- "TStamp":{"type":"timestamp"},
- "Tag":{
- "type":"structure",
- "required":["Key"],
- "members":{
- "Key":{
- "shape":"TagKey",
- "documentation":"The key of the tag.
"
- },
- "Value":{
- "shape":"TagValue",
- "documentation":"The value of the tag.
"
- }
- },
- "documentation":"A key-value pair that identifies or specifies metadata about an ACM resource.
"
- },
- "TagKey":{
- "type":"string",
- "max":128,
- "min":1,
- "pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*"
- },
- "TagList":{
- "type":"list",
- "member":{"shape":"Tag"},
- "max":50,
- "min":1
- },
- "TagValue":{
- "type":"string",
- "max":256,
- "min":0,
- "pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*"
- },
- "TooManyTagsException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"The request contains too many tags. Try the request again with fewer tags.
",
- "exception":true
- },
- "UpdateCertificateOptionsRequest":{
- "type":"structure",
- "required":[
- "CertificateArn",
- "Options"
- ],
- "members":{
- "CertificateArn":{
- "shape":"Arn",
- "documentation":"ARN of the requested certificate to update. This must be of the form:
arn:aws:acm:us-east-1:account:certificate/12345678-1234-1234-1234-123456789012
"
- },
- "Options":{
- "shape":"CertificateOptions",
- "documentation":"Use to update the options for your certificate. Currently, you can specify whether to add your certificate to a transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser.
"
- }
- }
- },
- "ValidationEmailList":{
- "type":"list",
- "member":{"shape":"String"}
- },
- "ValidationMethod":{
- "type":"string",
- "enum":[
- "EMAIL",
- "DNS"
- ]
- }
- },
- "documentation":"AWS Certificate Manager Welcome to the AWS Certificate Manager (ACM) API documentation.
You can use ACM to manage SSL/TLS certificates for your AWS-based websites and applications. For general information about using ACM, see the AWS Certificate Manager User Guide .
"
-}
diff --git a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/acm/2015-12-08/waiters-2.json b/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/acm/2015-12-08/waiters-2.json
deleted file mode 100644
index 1fba453d..00000000
--- a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/acm/2015-12-08/waiters-2.json
+++ /dev/null
@@ -1,35 +0,0 @@
-{
- "version": 2,
- "waiters": {
- "CertificateValidated": {
- "delay": 60,
- "maxAttempts": 40,
- "operation": "DescribeCertificate",
- "acceptors": [
- {
- "matcher": "pathAll",
- "expected": "SUCCESS",
- "argument": "Certificate.DomainValidationOptions[].ValidationStatus",
- "state": "success"
- },
- {
- "matcher": "pathAny",
- "expected": "PENDING_VALIDATION",
- "argument": "Certificate.DomainValidationOptions[].ValidationStatus",
- "state": "retry"
- },
- {
- "matcher": "path",
- "expected": "FAILED",
- "argument": "Certificate.Status",
- "state": "failure"
- },
- {
- "matcher": "error",
- "expected": "ResourceNotFoundException",
- "state": "failure"
- }
- ]
- }
- }
-}
diff --git a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/alexaforbusiness/2017-11-09/paginators-1.json b/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/alexaforbusiness/2017-11-09/paginators-1.json
deleted file mode 100644
index a91b700d..00000000
--- a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/alexaforbusiness/2017-11-09/paginators-1.json
+++ /dev/null
@@ -1,46 +0,0 @@
-{
- "pagination": {
- "ListSkills": {
- "result_key": "SkillSummaries",
- "output_token": "NextToken",
- "input_token": "NextToken",
- "limit_key": "MaxResults"
- },
- "SearchUsers": {
- "result_key": "Users",
- "output_token": "NextToken",
- "input_token": "NextToken",
- "limit_key": "MaxResults"
- },
- "ListTags": {
- "result_key": "Tags",
- "output_token": "NextToken",
- "input_token": "NextToken",
- "limit_key": "MaxResults"
- },
- "SearchProfiles": {
- "result_key": "Profiles",
- "output_token": "NextToken",
- "input_token": "NextToken",
- "limit_key": "MaxResults"
- },
- "SearchSkillGroups": {
- "result_key": "SkillGroups",
- "output_token": "NextToken",
- "input_token": "NextToken",
- "limit_key": "MaxResults"
- },
- "SearchDevices": {
- "result_key": "Devices",
- "output_token": "NextToken",
- "input_token": "NextToken",
- "limit_key": "MaxResults"
- },
- "SearchRooms": {
- "result_key": "Rooms",
- "output_token": "NextToken",
- "input_token": "NextToken",
- "limit_key": "MaxResults"
- }
- }
-}
diff --git a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/alexaforbusiness/2017-11-09/service-2.json b/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/alexaforbusiness/2017-11-09/service-2.json
deleted file mode 100644
index 1e5ccc9c..00000000
--- a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/alexaforbusiness/2017-11-09/service-2.json
+++ /dev/null
@@ -1,2843 +0,0 @@
-{
- "version":"2.0",
- "metadata":{
- "apiVersion":"2017-11-09",
- "endpointPrefix":"a4b",
- "jsonVersion":"1.1",
- "protocol":"json",
- "serviceFullName":"Alexa For Business",
- "serviceId":"Alexa For Business",
- "signatureVersion":"v4",
- "targetPrefix":"AlexaForBusiness",
- "uid":"alexaforbusiness-2017-11-09"
- },
- "operations":{
- "AssociateContactWithAddressBook":{
- "name":"AssociateContactWithAddressBook",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"AssociateContactWithAddressBookRequest"},
- "output":{"shape":"AssociateContactWithAddressBookResponse"},
- "errors":[
- {"shape":"LimitExceededException"}
- ],
- "documentation":"Associates a contact with a given address book.
"
- },
- "AssociateDeviceWithRoom":{
- "name":"AssociateDeviceWithRoom",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"AssociateDeviceWithRoomRequest"},
- "output":{"shape":"AssociateDeviceWithRoomResponse"},
- "errors":[
- {"shape":"LimitExceededException"},
- {"shape":"DeviceNotRegisteredException"}
- ],
- "documentation":"Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required.
"
- },
- "AssociateSkillGroupWithRoom":{
- "name":"AssociateSkillGroupWithRoom",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"AssociateSkillGroupWithRoomRequest"},
- "output":{"shape":"AssociateSkillGroupWithRoomResponse"},
- "documentation":"Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
"
- },
- "CreateAddressBook":{
- "name":"CreateAddressBook",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"CreateAddressBookRequest"},
- "output":{"shape":"CreateAddressBookResponse"},
- "errors":[
- {"shape":"AlreadyExistsException"},
- {"shape":"LimitExceededException"}
- ],
- "documentation":"Creates an address book with the specified details.
"
- },
- "CreateContact":{
- "name":"CreateContact",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"CreateContactRequest"},
- "output":{"shape":"CreateContactResponse"},
- "errors":[
- {"shape":"AlreadyExistsException"},
- {"shape":"LimitExceededException"}
- ],
- "documentation":"Creates a contact with the specified details.
"
- },
- "CreateProfile":{
- "name":"CreateProfile",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"CreateProfileRequest"},
- "output":{"shape":"CreateProfileResponse"},
- "errors":[
- {"shape":"LimitExceededException"},
- {"shape":"AlreadyExistsException"}
- ],
- "documentation":"Creates a new room profile with the specified details.
"
- },
- "CreateRoom":{
- "name":"CreateRoom",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"CreateRoomRequest"},
- "output":{"shape":"CreateRoomResponse"},
- "errors":[
- {"shape":"AlreadyExistsException"},
- {"shape":"LimitExceededException"}
- ],
- "documentation":"Creates a room with the specified details.
"
- },
- "CreateSkillGroup":{
- "name":"CreateSkillGroup",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"CreateSkillGroupRequest"},
- "output":{"shape":"CreateSkillGroupResponse"},
- "errors":[
- {"shape":"AlreadyExistsException"},
- {"shape":"LimitExceededException"}
- ],
- "documentation":"Creates a skill group with a specified name and description.
"
- },
- "CreateUser":{
- "name":"CreateUser",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"CreateUserRequest"},
- "output":{"shape":"CreateUserResponse"},
- "errors":[
- {"shape":"ResourceInUseException"},
- {"shape":"LimitExceededException"}
- ],
- "documentation":"Creates a user.
"
- },
- "DeleteAddressBook":{
- "name":"DeleteAddressBook",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"DeleteAddressBookRequest"},
- "output":{"shape":"DeleteAddressBookResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Deletes an address book by the address book ARN.
"
- },
- "DeleteContact":{
- "name":"DeleteContact",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"DeleteContactRequest"},
- "output":{"shape":"DeleteContactResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Deletes a contact by the contact ARN.
"
- },
- "DeleteProfile":{
- "name":"DeleteProfile",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"DeleteProfileRequest"},
- "output":{"shape":"DeleteProfileResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Deletes a room profile by the profile ARN.
"
- },
- "DeleteRoom":{
- "name":"DeleteRoom",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"DeleteRoomRequest"},
- "output":{"shape":"DeleteRoomResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Deletes a room by the room ARN.
"
- },
- "DeleteRoomSkillParameter":{
- "name":"DeleteRoomSkillParameter",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"DeleteRoomSkillParameterRequest"},
- "output":{"shape":"DeleteRoomSkillParameterResponse"},
- "documentation":"Deletes room skill parameter details by room, skill, and parameter key ID.
"
- },
- "DeleteSkillGroup":{
- "name":"DeleteSkillGroup",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"DeleteSkillGroupRequest"},
- "output":{"shape":"DeleteSkillGroupResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Deletes a skill group by skill group ARN.
"
- },
- "DeleteUser":{
- "name":"DeleteUser",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"DeleteUserRequest"},
- "output":{"shape":"DeleteUserResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Deletes a specified user by user ARN and enrollment ARN.
"
- },
- "DisassociateContactFromAddressBook":{
- "name":"DisassociateContactFromAddressBook",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"DisassociateContactFromAddressBookRequest"},
- "output":{"shape":"DisassociateContactFromAddressBookResponse"},
- "documentation":"Disassociates a contact from a given address book.
"
- },
- "DisassociateDeviceFromRoom":{
- "name":"DisassociateDeviceFromRoom",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"DisassociateDeviceFromRoomRequest"},
- "output":{"shape":"DisassociateDeviceFromRoomResponse"},
- "errors":[
- {"shape":"DeviceNotRegisteredException"}
- ],
- "documentation":"Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.
"
- },
- "DisassociateSkillGroupFromRoom":{
- "name":"DisassociateSkillGroupFromRoom",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"DisassociateSkillGroupFromRoomRequest"},
- "output":{"shape":"DisassociateSkillGroupFromRoomResponse"},
- "documentation":"Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
"
- },
- "GetAddressBook":{
- "name":"GetAddressBook",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"GetAddressBookRequest"},
- "output":{"shape":"GetAddressBookResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Gets address the book details by the address book ARN.
"
- },
- "GetContact":{
- "name":"GetContact",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"GetContactRequest"},
- "output":{"shape":"GetContactResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Gets the contact details by the contact ARN.
"
- },
- "GetDevice":{
- "name":"GetDevice",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"GetDeviceRequest"},
- "output":{"shape":"GetDeviceResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Gets the details of a device by device ARN.
"
- },
- "GetProfile":{
- "name":"GetProfile",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"GetProfileRequest"},
- "output":{"shape":"GetProfileResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Gets the details of a room profile by profile ARN.
"
- },
- "GetRoom":{
- "name":"GetRoom",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"GetRoomRequest"},
- "output":{"shape":"GetRoomResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Gets room details by room ARN.
"
- },
- "GetRoomSkillParameter":{
- "name":"GetRoomSkillParameter",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"GetRoomSkillParameterRequest"},
- "output":{"shape":"GetRoomSkillParameterResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Gets room skill parameter details by room, skill, and parameter key ARN.
"
- },
- "GetSkillGroup":{
- "name":"GetSkillGroup",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"GetSkillGroupRequest"},
- "output":{"shape":"GetSkillGroupResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Gets skill group details by skill group ARN.
"
- },
- "ListDeviceEvents":{
- "name":"ListDeviceEvents",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"ListDeviceEventsRequest"},
- "output":{"shape":"ListDeviceEventsResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Lists the device event history, including device connection status, for up to 30 days.
"
- },
- "ListSkills":{
- "name":"ListSkills",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"ListSkillsRequest"},
- "output":{"shape":"ListSkillsResponse"},
- "documentation":"Lists all enabled skills in a specific skill group.
"
- },
- "ListTags":{
- "name":"ListTags",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"ListTagsRequest"},
- "output":{"shape":"ListTagsResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Lists all tags for the specified resource.
"
- },
- "PutRoomSkillParameter":{
- "name":"PutRoomSkillParameter",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"PutRoomSkillParameterRequest"},
- "output":{"shape":"PutRoomSkillParameterResponse"},
- "documentation":"Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
"
- },
- "ResolveRoom":{
- "name":"ResolveRoom",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"ResolveRoomRequest"},
- "output":{"shape":"ResolveRoomResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
"
- },
- "RevokeInvitation":{
- "name":"RevokeInvitation",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"RevokeInvitationRequest"},
- "output":{"shape":"RevokeInvitationResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Revokes an invitation and invalidates the enrollment URL.
"
- },
- "SearchAddressBooks":{
- "name":"SearchAddressBooks",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"SearchAddressBooksRequest"},
- "output":{"shape":"SearchAddressBooksResponse"},
- "documentation":"Searches address books and lists the ones that meet a set of filter and sort criteria.
"
- },
- "SearchContacts":{
- "name":"SearchContacts",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"SearchContactsRequest"},
- "output":{"shape":"SearchContactsResponse"},
- "documentation":"Searches contacts and lists the ones that meet a set of filter and sort criteria.
"
- },
- "SearchDevices":{
- "name":"SearchDevices",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"SearchDevicesRequest"},
- "output":{"shape":"SearchDevicesResponse"},
- "documentation":"Searches devices and lists the ones that meet a set of filter criteria.
"
- },
- "SearchProfiles":{
- "name":"SearchProfiles",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"SearchProfilesRequest"},
- "output":{"shape":"SearchProfilesResponse"},
- "documentation":"Searches room profiles and lists the ones that meet a set of filter criteria.
"
- },
- "SearchRooms":{
- "name":"SearchRooms",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"SearchRoomsRequest"},
- "output":{"shape":"SearchRoomsResponse"},
- "documentation":"Searches rooms and lists the ones that meet a set of filter and sort criteria.
"
- },
- "SearchSkillGroups":{
- "name":"SearchSkillGroups",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"SearchSkillGroupsRequest"},
- "output":{"shape":"SearchSkillGroupsResponse"},
- "documentation":"Searches skill groups and lists the ones that meet a set of filter and sort criteria.
"
- },
- "SearchUsers":{
- "name":"SearchUsers",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"SearchUsersRequest"},
- "output":{"shape":"SearchUsersResponse"},
- "documentation":"Searches users and lists the ones that meet a set of filter and sort criteria.
"
- },
- "SendInvitation":{
- "name":"SendInvitation",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"SendInvitationRequest"},
- "output":{"shape":"SendInvitationResponse"},
- "errors":[
- {"shape":"NotFoundException"},
- {"shape":"InvalidUserStatusException"}
- ],
- "documentation":"Sends an enrollment invitation email with a URL to a user. The URL is valid for 72 hours or until you call this operation again, whichever comes first.
"
- },
- "StartDeviceSync":{
- "name":"StartDeviceSync",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"StartDeviceSyncRequest"},
- "output":{"shape":"StartDeviceSyncResponse"},
- "errors":[
- {"shape":"DeviceNotRegisteredException"}
- ],
- "documentation":"Resets a device and its account to the known default settings, by clearing all information and settings set by previous users.
"
- },
- "TagResource":{
- "name":"TagResource",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"TagResourceRequest"},
- "output":{"shape":"TagResourceResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Adds metadata tags to a specified resource.
"
- },
- "UntagResource":{
- "name":"UntagResource",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"UntagResourceRequest"},
- "output":{"shape":"UntagResourceResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Removes metadata tags from a specified resource.
"
- },
- "UpdateAddressBook":{
- "name":"UpdateAddressBook",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"UpdateAddressBookRequest"},
- "output":{"shape":"UpdateAddressBookResponse"},
- "errors":[
- {"shape":"NotFoundException"},
- {"shape":"NameInUseException"}
- ],
- "documentation":"Updates address book details by the address book ARN.
"
- },
- "UpdateContact":{
- "name":"UpdateContact",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"UpdateContactRequest"},
- "output":{"shape":"UpdateContactResponse"},
- "errors":[
- {"shape":"NotFoundException"}
- ],
- "documentation":"Updates the contact details by the contact ARN.
"
- },
- "UpdateDevice":{
- "name":"UpdateDevice",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"UpdateDeviceRequest"},
- "output":{"shape":"UpdateDeviceResponse"},
- "errors":[
- {"shape":"NotFoundException"},
- {"shape":"DeviceNotRegisteredException"}
- ],
- "documentation":"Updates the device name by device ARN.
"
- },
- "UpdateProfile":{
- "name":"UpdateProfile",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"UpdateProfileRequest"},
- "output":{"shape":"UpdateProfileResponse"},
- "errors":[
- {"shape":"NotFoundException"},
- {"shape":"NameInUseException"}
- ],
- "documentation":"Updates an existing room profile by room profile ARN.
"
- },
- "UpdateRoom":{
- "name":"UpdateRoom",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"UpdateRoomRequest"},
- "output":{"shape":"UpdateRoomResponse"},
- "errors":[
- {"shape":"NotFoundException"},
- {"shape":"NameInUseException"}
- ],
- "documentation":"Updates room details by room ARN.
"
- },
- "UpdateSkillGroup":{
- "name":"UpdateSkillGroup",
- "http":{
- "method":"POST",
- "requestUri":"/"
- },
- "input":{"shape":"UpdateSkillGroupRequest"},
- "output":{"shape":"UpdateSkillGroupResponse"},
- "errors":[
- {"shape":"NotFoundException"},
- {"shape":"NameInUseException"}
- ],
- "documentation":"Updates skill group details by skill group ARN.
"
- }
- },
- "shapes":{
- "Address":{
- "type":"string",
- "max":500,
- "min":1
- },
- "AddressBook":{
- "type":"structure",
- "members":{
- "AddressBookArn":{
- "shape":"Arn",
- "documentation":"The ARN of the address book.
"
- },
- "Name":{
- "shape":"AddressBookName",
- "documentation":"The name of the address book.
"
- },
- "Description":{
- "shape":"AddressBookDescription",
- "documentation":"The description of the address book.
"
- }
- },
- "documentation":"An address book with attributes.
"
- },
- "AddressBookData":{
- "type":"structure",
- "members":{
- "AddressBookArn":{
- "shape":"Arn",
- "documentation":"The ARN of the address book.
"
- },
- "Name":{
- "shape":"AddressBookName",
- "documentation":"The name of the address book.
"
- },
- "Description":{
- "shape":"AddressBookDescription",
- "documentation":"The description of the address book.
"
- }
- },
- "documentation":"Information related to an address book.
"
- },
- "AddressBookDataList":{
- "type":"list",
- "member":{"shape":"AddressBookData"}
- },
- "AddressBookDescription":{
- "type":"string",
- "max":200,
- "min":1,
- "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*"
- },
- "AddressBookName":{
- "type":"string",
- "max":100,
- "min":1,
- "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*"
- },
- "AlreadyExistsException":{
- "type":"structure",
- "members":{
- "Message":{"shape":"ErrorMessage"}
- },
- "documentation":"The resource being created already exists. HTTP Status Code: 400
",
- "exception":true
- },
- "Arn":{
- "type":"string",
- "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}"
- },
- "AssociateContactWithAddressBookRequest":{
- "type":"structure",
- "required":[
- "ContactArn",
- "AddressBookArn"
- ],
- "members":{
- "ContactArn":{
- "shape":"Arn",
- "documentation":"The ARN of the contact to associate with an address book.
"
- },
- "AddressBookArn":{
- "shape":"Arn",
- "documentation":"The ARN of the address book with which to associate the contact.
"
- }
- }
- },
- "AssociateContactWithAddressBookResponse":{
- "type":"structure",
- "members":{
- }
- },
- "AssociateDeviceWithRoomRequest":{
- "type":"structure",
- "members":{
- "DeviceArn":{
- "shape":"Arn",
- "documentation":"The ARN of the device to associate to a room. Required.
"
- },
- "RoomArn":{
- "shape":"Arn",
- "documentation":"The ARN of the room with which to associate the device. Required.
"
- }
- }
- },
- "AssociateDeviceWithRoomResponse":{
- "type":"structure",
- "members":{
- }
- },
- "AssociateSkillGroupWithRoomRequest":{
- "type":"structure",
- "members":{
- "SkillGroupArn":{
- "shape":"Arn",
- "documentation":"The ARN of the skill group to associate with a room. Required.
"
- },
- "RoomArn":{
- "shape":"Arn",
- "documentation":"The ARN of the room with which to associate the skill group. Required.
"
- }
- }
- },
- "AssociateSkillGroupWithRoomResponse":{
- "type":"structure",
- "members":{
- }
- },
- "Boolean":{"type":"boolean"},
- "ClientRequestToken":{
- "type":"string",
- "documentation":"User specified token that is used to support idempotency during Create Resource",
- "max":150,
- "min":10,
- "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*"
- },
- "ConnectionStatus":{
- "type":"string",
- "enum":[
- "ONLINE",
- "OFFLINE"
- ]
- },
- "Contact":{
- "type":"structure",
- "members":{
- "ContactArn":{
- "shape":"Arn",
- "documentation":"The ARN of the contact.
"
- },
- "DisplayName":{
- "shape":"ContactName",
- "documentation":"The name of the contact to display on the console.
"
- },
- "FirstName":{
- "shape":"ContactName",
- "documentation":"The first name of the contact, used to call the contact on the device.
"
- },
- "LastName":{
- "shape":"ContactName",
- "documentation":"The last name of the contact, used to call the contact on the device.
"
- },
- "PhoneNumber":{
- "shape":"E164PhoneNumber",
- "documentation":"The phone number of the contact.
"
- }
- },
- "documentation":"A contact with attributes.
"
- },
- "ContactData":{
- "type":"structure",
- "members":{
- "ContactArn":{
- "shape":"Arn",
- "documentation":"The ARN of the contact.
"
- },
- "DisplayName":{
- "shape":"ContactName",
- "documentation":"The name of the contact to display on the console.
"
- },
- "FirstName":{
- "shape":"ContactName",
- "documentation":"The first name of the contact, used to call the contact on the device.
"
- },
- "LastName":{
- "shape":"ContactName",
- "documentation":"The last name of the contact, used to call the contact on the device.
"
- },
- "PhoneNumber":{
- "shape":"E164PhoneNumber",
- "documentation":"The phone number of the contact.
"
- }
- },
- "documentation":"Information related to a contact.
"
- },
- "ContactDataList":{
- "type":"list",
- "member":{"shape":"ContactData"}
- },
- "ContactName":{
- "type":"string",
- "max":100,
- "min":1,
- "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*"
- },
- "CreateAddressBookRequest":{
- "type":"structure",
- "required":["Name"],
- "members":{
- "Name":{
- "shape":"AddressBookName",
- "documentation":"The name of the address book.
"
- },
- "Description":{
- "shape":"AddressBookDescription",
- "documentation":"The description of the address book.
"
- },
- "ClientRequestToken":{
- "shape":"ClientRequestToken",
- "documentation":"A unique, user-specified identifier for the request that ensures idempotency.
",
- "idempotencyToken":true
- }
- }
- },
- "CreateAddressBookResponse":{
- "type":"structure",
- "members":{
- "AddressBookArn":{
- "shape":"Arn",
- "documentation":"The ARN of the newly created address book.
"
- }
- }
- },
- "CreateContactRequest":{
- "type":"structure",
- "required":[
- "FirstName",
- "PhoneNumber"
- ],
- "members":{
- "DisplayName":{
- "shape":"ContactName",
- "documentation":"The name of the contact to display on the console.
"
- },
- "FirstName":{
- "shape":"ContactName",
- "documentation":"The first name of the contact that is used to call the contact on the device.
"
- },
- "LastName":{
- "shape":"ContactName",
- "documentation":"The last name of the contact that is used to call the contact on the device.
"
- },
- "PhoneNumber":{
- "shape":"E164PhoneNumber",
- "documentation":"The phone number of the contact in E.164 format.
"
- },
- "ClientRequestToken":{
- "shape":"ClientRequestToken",
- "documentation":"A unique, user-specified identifier for this request that ensures idempotency.
",
- "idempotencyToken":true
- }
- }
- },
- "CreateContactResponse":{
- "type":"structure",
- "members":{
- "ContactArn":{
- "shape":"Arn",
- "documentation":"The ARN of the newly created address book.
"
- }
- }
- },
- "CreateProfileRequest":{
- "type":"structure",
- "required":[
- "ProfileName",
- "Timezone",
- "Address",
- "DistanceUnit",
- "TemperatureUnit",
- "WakeWord"
- ],
- "members":{
- "ProfileName":{
- "shape":"ProfileName",
- "documentation":"The name of a room profile.
"
- },
- "Timezone":{
- "shape":"Timezone",
- "documentation":"The time zone used by a room profile.
"
- },
- "Address":{
- "shape":"Address",
- "documentation":"The valid address for the room.
"
- },
- "DistanceUnit":{
- "shape":"DistanceUnit",
- "documentation":"The distance unit to be used by devices in the profile.
"
- },
- "TemperatureUnit":{
- "shape":"TemperatureUnit",
- "documentation":"The temperature unit to be used by devices in the profile.
"
- },
- "WakeWord":{
- "shape":"WakeWord",
- "documentation":"A wake word for Alexa, Echo, Amazon, or a computer.
"
- },
- "ClientRequestToken":{
- "shape":"ClientRequestToken",
- "documentation":"The user-specified token that is used during the creation of a profile.
",
- "idempotencyToken":true
- },
- "SetupModeDisabled":{
- "shape":"Boolean",
- "documentation":"Whether room profile setup is enabled.
"
- },
- "MaxVolumeLimit":{
- "shape":"MaxVolumeLimit",
- "documentation":"The maximum volume limit for a room profile.
"
- },
- "PSTNEnabled":{
- "shape":"Boolean",
- "documentation":"Whether PSTN calling is enabled.
"
- }
- }
- },
- "CreateProfileResponse":{
- "type":"structure",
- "members":{
- "ProfileArn":{
- "shape":"Arn",
- "documentation":"The ARN of the newly created room profile in the response.
"
- }
- }
- },
- "CreateRoomRequest":{
- "type":"structure",
- "required":["RoomName"],
- "members":{
- "RoomName":{
- "shape":"RoomName",
- "documentation":"The name for the room.
"
- },
- "Description":{
- "shape":"RoomDescription",
- "documentation":"The description for the room.
"
- },
- "ProfileArn":{
- "shape":"Arn",
- "documentation":"The profile ARN for the room.
"
- },
- "ProviderCalendarId":{
- "shape":"ProviderCalendarId",
- "documentation":"The calendar ARN for the room.
"
- },
- "ClientRequestToken":{
- "shape":"ClientRequestToken",
- "documentation":"A unique, user-specified identifier for this request that ensures idempotency.
",
- "idempotencyToken":true
- },
- "Tags":{
- "shape":"TagList",
- "documentation":"The tags for the room.
"
- }
- }
- },
- "CreateRoomResponse":{
- "type":"structure",
- "members":{
- "RoomArn":{
- "shape":"Arn",
- "documentation":"The ARN of the newly created room in the response.
"
- }
- }
- },
- "CreateSkillGroupRequest":{
- "type":"structure",
- "required":["SkillGroupName"],
- "members":{
- "SkillGroupName":{
- "shape":"SkillGroupName",
- "documentation":"The name for the skill group.
"
- },
- "Description":{
- "shape":"SkillGroupDescription",
- "documentation":"The description for the skill group.
"
- },
- "ClientRequestToken":{
- "shape":"ClientRequestToken",
- "documentation":"A unique, user-specified identifier for this request that ensures idempotency.
",
- "idempotencyToken":true
- }
- }
- },
- "CreateSkillGroupResponse":{
- "type":"structure",
- "members":{
- "SkillGroupArn":{
- "shape":"Arn",
- "documentation":"The ARN of the newly created skill group in the response.
"
- }
- }
- },
- "CreateUserRequest":{
- "type":"structure",
- "required":["UserId"],
- "members":{
- "UserId":{
- "shape":"user_UserId",
- "documentation":"The ARN for the user.
"
- },
- "FirstName":{
- "shape":"user_FirstName",
- "documentation":"The first name for the user.
"
- },
- "LastName":{
- "shape":"user_LastName",
- "documentation":"The last name for the user.
"
- },
- "Email":{
- "shape":"Email",
- "documentation":"The email address for the user.
"
- },
- "ClientRequestToken":{
- "shape":"ClientRequestToken",
- "documentation":"A unique, user-specified identifier for this request that ensures idempotency.
",
- "idempotencyToken":true
- },
- "Tags":{
- "shape":"TagList",
- "documentation":"The tags for the user.
"
- }
- }
- },
- "CreateUserResponse":{
- "type":"structure",
- "members":{
- "UserArn":{
- "shape":"Arn",
- "documentation":"The ARN of the newly created user in the response.
"
- }
- }
- },
- "DeleteAddressBookRequest":{
- "type":"structure",
- "required":["AddressBookArn"],
- "members":{
- "AddressBookArn":{
- "shape":"Arn",
- "documentation":"The ARN of the address book to delete.
"
- }
- }
- },
- "DeleteAddressBookResponse":{
- "type":"structure",
- "members":{
- }
- },
- "DeleteContactRequest":{
- "type":"structure",
- "required":["ContactArn"],
- "members":{
- "ContactArn":{
- "shape":"Arn",
- "documentation":"The ARN of the contact to delete.
"
- }
- }
- },
- "DeleteContactResponse":{
- "type":"structure",
- "members":{
- }
- },
- "DeleteProfileRequest":{
- "type":"structure",
- "members":{
- "ProfileArn":{
- "shape":"Arn",
- "documentation":"The ARN of the room profile to delete. Required.
"
- }
- }
- },
- "DeleteProfileResponse":{
- "type":"structure",
- "members":{
- }
- },
- "DeleteRoomRequest":{
- "type":"structure",
- "members":{
- "RoomArn":{
- "shape":"Arn",
- "documentation":"The ARN of the room to delete. Required.
"
- }
- }
- },
- "DeleteRoomResponse":{
- "type":"structure",
- "members":{
- }
- },
- "DeleteRoomSkillParameterRequest":{
- "type":"structure",
- "required":[
- "SkillId",
- "ParameterKey"
- ],
- "members":{
- "RoomArn":{
- "shape":"Arn",
- "documentation":"The ARN of the room from which to remove the room skill parameter details.
"
- },
- "SkillId":{
- "shape":"SkillId",
- "documentation":"The ID of the skill from which to remove the room skill parameter details.
"
- },
- "ParameterKey":{
- "shape":"RoomSkillParameterKey",
- "documentation":"The room skill parameter key for which to remove details.
"
- }
- }
- },
- "DeleteRoomSkillParameterResponse":{
- "type":"structure",
- "members":{
- }
- },
- "DeleteSkillGroupRequest":{
- "type":"structure",
- "members":{
- "SkillGroupArn":{
- "shape":"Arn",
- "documentation":"The ARN of the skill group to delete. Required.
"
- }
- }
- },
- "DeleteSkillGroupResponse":{
- "type":"structure",
- "members":{
- }
- },
- "DeleteUserRequest":{
- "type":"structure",
- "required":["EnrollmentId"],
- "members":{
- "UserArn":{
- "shape":"Arn",
- "documentation":"The ARN of the user to delete in the organization. Required.
"
- },
- "EnrollmentId":{
- "shape":"EnrollmentId",
- "documentation":"The ARN of the user's enrollment in the organization. Required.
"
- }
- }
- },
- "DeleteUserResponse":{
- "type":"structure",
- "members":{
- }
- },
- "Device":{
- "type":"structure",
- "members":{
- "DeviceArn":{
- "shape":"Arn",
- "documentation":"The ARN of a device.
"
- },
- "DeviceSerialNumber":{
- "shape":"DeviceSerialNumber",
- "documentation":"The serial number of a device.
"
- },
- "DeviceType":{
- "shape":"DeviceType",
- "documentation":"The type of a device.
"
- },
- "DeviceName":{
- "shape":"DeviceName",
- "documentation":"The name of a device.
"
- },
- "SoftwareVersion":{
- "shape":"SoftwareVersion",
- "documentation":"The software version of a device.
"
- },
- "MacAddress":{
- "shape":"MacAddress",
- "documentation":"The MAC address of a device.
"
- },
- "RoomArn":{
- "shape":"Arn",
- "documentation":"The room ARN of a device.
"
- },
- "DeviceStatus":{
- "shape":"DeviceStatus",
- "documentation":"The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.
"
- },
- "DeviceStatusInfo":{
- "shape":"DeviceStatusInfo",
- "documentation":"Detailed information about a device's status.
"
- }
- },
- "documentation":"A device with attributes.
"
- },
- "DeviceData":{
- "type":"structure",
- "members":{
- "DeviceArn":{
- "shape":"Arn",
- "documentation":"The ARN of a device.
"
- },
- "DeviceSerialNumber":{
- "shape":"DeviceSerialNumber",
- "documentation":"The serial number of a device.
"
- },
- "DeviceType":{
- "shape":"DeviceType",
- "documentation":"The type of a device.
"
- },
- "DeviceName":{
- "shape":"DeviceName",
- "documentation":"The name of a device.
"
- },
- "SoftwareVersion":{
- "shape":"SoftwareVersion",
- "documentation":"The software version of a device.
"
- },
- "MacAddress":{
- "shape":"MacAddress",
- "documentation":"The MAC address of a device.
"
- },
- "DeviceStatus":{
- "shape":"DeviceStatus",
- "documentation":"The status of a device.
"
- },
- "RoomArn":{
- "shape":"Arn",
- "documentation":"The room ARN associated with a device.
"
- },
- "RoomName":{
- "shape":"RoomName",
- "documentation":"The name of the room associated with a device.
"
- },
- "DeviceStatusInfo":{
- "shape":"DeviceStatusInfo",
- "documentation":"Detailed information about a device's status.
"
- }
- },
- "documentation":"Device attributes.
"
- },
- "DeviceDataList":{
- "type":"list",
- "member":{"shape":"DeviceData"}
- },
- "DeviceEvent":{
- "type":"structure",
- "members":{
- "Type":{
- "shape":"DeviceEventType",
- "documentation":"The type of device event.
"
- },
- "Value":{
- "shape":"DeviceEventValue",
- "documentation":"The value of the event.
"
- },
- "Timestamp":{
- "shape":"Timestamp",
- "documentation":"The time (in epoch) when the event occurred.
"
- }
- },
- "documentation":"The list of device events.
"
- },
- "DeviceEventList":{
- "type":"list",
- "member":{"shape":"DeviceEvent"}
- },
- "DeviceEventType":{
- "type":"string",
- "enum":[
- "CONNECTION_STATUS",
- "DEVICE_STATUS"
- ]
- },
- "DeviceEventValue":{"type":"string"},
- "DeviceName":{
- "type":"string",
- "max":100,
- "min":2,
- "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*"
- },
- "DeviceNotRegisteredException":{
- "type":"structure",
- "members":{
- "Message":{"shape":"ErrorMessage"}
- },
- "documentation":"The request failed because this device is no longer registered and therefore no longer managed by this account.
",
- "exception":true
- },
- "DeviceSerialNumber":{
- "type":"string",
- "pattern":"[a-zA-Z0-9]{1,200}"
- },
- "DeviceStatus":{
- "type":"string",
- "enum":[
- "READY",
- "PENDING",
- "WAS_OFFLINE",
- "DEREGISTERED"
- ]
- },
- "DeviceStatusDetail":{
- "type":"structure",
- "members":{
- "Code":{
- "shape":"DeviceStatusDetailCode",
- "documentation":"The device status detail code.
"
- }
- },
- "documentation":"Details of a device’s status.
"
- },
- "DeviceStatusDetailCode":{
- "type":"string",
- "enum":[
- "DEVICE_SOFTWARE_UPDATE_NEEDED",
- "DEVICE_WAS_OFFLINE"
- ]
- },
- "DeviceStatusDetails":{
- "type":"list",
- "member":{"shape":"DeviceStatusDetail"}
- },
- "DeviceStatusInfo":{
- "type":"structure",
- "members":{
- "DeviceStatusDetails":{
- "shape":"DeviceStatusDetails",
- "documentation":"One or more device status detail descriptions.
"
- },
- "ConnectionStatus":{
- "shape":"ConnectionStatus",
- "documentation":"The latest available information about the connection status of a device.
"
- }
- },
- "documentation":"Detailed information about a device's status.
"
- },
- "DeviceType":{
- "type":"string",
- "pattern":"[a-zA-Z0-9]{1,200}"
- },
- "DisassociateContactFromAddressBookRequest":{
- "type":"structure",
- "required":[
- "ContactArn",
- "AddressBookArn"
- ],
- "members":{
- "ContactArn":{
- "shape":"Arn",
- "documentation":"The ARN of the contact to disassociate from an address book.
"
- },
- "AddressBookArn":{
- "shape":"Arn",
- "documentation":"The ARN of the address from which to disassociate the contact.
"
- }
- }
- },
- "DisassociateContactFromAddressBookResponse":{
- "type":"structure",
- "members":{
- }
- },
- "DisassociateDeviceFromRoomRequest":{
- "type":"structure",
- "members":{
- "DeviceArn":{
- "shape":"Arn",
- "documentation":"The ARN of the device to disassociate from a room. Required.
"
- }
- }
- },
- "DisassociateDeviceFromRoomResponse":{
- "type":"structure",
- "members":{
- }
- },
- "DisassociateSkillGroupFromRoomRequest":{
- "type":"structure",
- "members":{
- "SkillGroupArn":{
- "shape":"Arn",
- "documentation":"The ARN of the skill group to disassociate from a room. Required.
"
- },
- "RoomArn":{
- "shape":"Arn",
- "documentation":"The ARN of the room from which the skill group is to be disassociated. Required.
"
- }
- }
- },
- "DisassociateSkillGroupFromRoomResponse":{
- "type":"structure",
- "members":{
- }
- },
- "DistanceUnit":{
- "type":"string",
- "enum":[
- "METRIC",
- "IMPERIAL"
- ]
- },
- "E164PhoneNumber":{
- "type":"string",
- "pattern":"^\\+\\d{8,}$"
- },
- "Email":{
- "type":"string",
- "max":128,
- "min":1,
- "pattern":"([0-9a-zA-Z]([+-.\\w]*[0-9a-zA-Z])*@([0-9a-zA-Z][-\\w]*[0-9a-zA-Z]\\.)+[a-zA-Z]{2,9})"
- },
- "EnrollmentId":{
- "type":"string",
- "max":128,
- "min":0
- },
- "EnrollmentStatus":{
- "type":"string",
- "enum":[
- "INITIALIZED",
- "PENDING",
- "REGISTERED",
- "DISASSOCIATING",
- "DEREGISTERING"
- ]
- },
- "ErrorMessage":{"type":"string"},
- "Feature":{
- "type":"string",
- "enum":[
- "BLUETOOTH",
- "VOLUME",
- "NOTIFICATIONS",
- "LISTS",
- "SKILLS",
- "ALL"
- ]
- },
- "Features":{
- "type":"list",
- "member":{"shape":"Feature"}
- },
- "Filter":{
- "type":"structure",
- "required":[
- "Key",
- "Values"
- ],
- "members":{
- "Key":{
- "shape":"FilterKey",
- "documentation":"The key of a filter.
"
- },
- "Values":{
- "shape":"FilterValueList",
- "documentation":"The values of a filter.
"
- }
- },
- "documentation":"A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.
"
- },
- "FilterKey":{
- "type":"string",
- "max":500,
- "min":1
- },
- "FilterList":{
- "type":"list",
- "member":{"shape":"Filter"},
- "max":25
- },
- "FilterValue":{
- "type":"string",
- "max":500,
- "min":1
- },
- "FilterValueList":{
- "type":"list",
- "member":{"shape":"FilterValue"},
- "max":5
- },
- "GetAddressBookRequest":{
- "type":"structure",
- "required":["AddressBookArn"],
- "members":{
- "AddressBookArn":{
- "shape":"Arn",
- "documentation":"The ARN of the address book for which to request details.
"
- }
- }
- },
- "GetAddressBookResponse":{
- "type":"structure",
- "members":{
- "AddressBook":{
- "shape":"AddressBook",
- "documentation":"The details of the requested address book.
"
- }
- }
- },
- "GetContactRequest":{
- "type":"structure",
- "required":["ContactArn"],
- "members":{
- "ContactArn":{
- "shape":"Arn",
- "documentation":"The ARN of the contact for which to request details.
"
- }
- }
- },
- "GetContactResponse":{
- "type":"structure",
- "members":{
- "Contact":{
- "shape":"Contact",
- "documentation":"The details of the requested contact.
"
- }
- }
- },
- "GetDeviceRequest":{
- "type":"structure",
- "members":{
- "DeviceArn":{
- "shape":"Arn",
- "documentation":"The ARN of the device for which to request details. Required.
"
- }
- }
- },
- "GetDeviceResponse":{
- "type":"structure",
- "members":{
- "Device":{
- "shape":"Device",
- "documentation":"The details of the device requested. Required.
"
- }
- }
- },
- "GetProfileRequest":{
- "type":"structure",
- "members":{
- "ProfileArn":{
- "shape":"Arn",
- "documentation":"The ARN of the room profile for which to request details. Required.
"
- }
- }
- },
- "GetProfileResponse":{
- "type":"structure",
- "members":{
- "Profile":{
- "shape":"Profile",
- "documentation":"The details of the room profile requested. Required.
"
- }
- }
- },
- "GetRoomRequest":{
- "type":"structure",
- "members":{
- "RoomArn":{
- "shape":"Arn",
- "documentation":"The ARN of the room for which to request details. Required.
"
- }
- }
- },
- "GetRoomResponse":{
- "type":"structure",
- "members":{
- "Room":{
- "shape":"Room",
- "documentation":"The details of the room requested.
"
- }
- }
- },
- "GetRoomSkillParameterRequest":{
- "type":"structure",
- "required":[
- "SkillId",
- "ParameterKey"
- ],
- "members":{
- "RoomArn":{
- "shape":"Arn",
- "documentation":"The ARN of the room from which to get the room skill parameter details.
"
- },
- "SkillId":{
- "shape":"SkillId",
- "documentation":"The ARN of the skill from which to get the room skill parameter details. Required.
"
- },
- "ParameterKey":{
- "shape":"RoomSkillParameterKey",
- "documentation":"The room skill parameter key for which to get details. Required.
"
- }
- }
- },
- "GetRoomSkillParameterResponse":{
- "type":"structure",
- "members":{
- "RoomSkillParameter":{
- "shape":"RoomSkillParameter",
- "documentation":"The details of the room skill parameter requested. Required.
"
- }
- }
- },
- "GetSkillGroupRequest":{
- "type":"structure",
- "members":{
- "SkillGroupArn":{
- "shape":"Arn",
- "documentation":"The ARN of the skill group for which to get details. Required.
"
- }
- }
- },
- "GetSkillGroupResponse":{
- "type":"structure",
- "members":{
- "SkillGroup":{
- "shape":"SkillGroup",
- "documentation":"The details of the skill group requested. Required.
"
- }
- }
- },
- "InvalidUserStatusException":{
- "type":"structure",
- "members":{
- "Message":{"shape":"ErrorMessage"}
- },
- "documentation":"The attempt to update a user is invalid due to the user's current status. HTTP Status Code: 400
",
- "exception":true
- },
- "LimitExceededException":{
- "type":"structure",
- "members":{
- "Message":{"shape":"ErrorMessage"}
- },
- "documentation":"You are performing an action that would put you beyond your account's limits. HTTP Status Code: 400
",
- "exception":true
- },
- "ListDeviceEventsRequest":{
- "type":"structure",
- "required":["DeviceArn"],
- "members":{
- "DeviceArn":{
- "shape":"Arn",
- "documentation":"The ARN of a device.
"
- },
- "EventType":{
- "shape":"DeviceEventType",
- "documentation":"The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.
"
- },
- "NextToken":{
- "shape":"NextToken",
- "documentation":"An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.
"
- },
- "MaxResults":{
- "shape":"MaxResults",
- "documentation":"The maximum number of results to include in the response. The default value is 50. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
"
- }
- }
- },
- "ListDeviceEventsResponse":{
- "type":"structure",
- "members":{
- "DeviceEvents":{
- "shape":"DeviceEventList",
- "documentation":"The device events requested for the device ARN.
"
- },
- "NextToken":{
- "shape":"NextToken",
- "documentation":"The token returned to indicate that there is more data available.
"
- }
- }
- },
- "ListSkillsRequest":{
- "type":"structure",
- "members":{
- "SkillGroupArn":{
- "shape":"Arn",
- "documentation":"The ARN of the skill group for which to list enabled skills. Required.
"
- },
- "NextToken":{
- "shape":"NextToken",
- "documentation":"An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.
"
- },
- "MaxResults":{
- "shape":"SkillListMaxResults",
- "documentation":"The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.
"
- }
- }
- },
- "ListSkillsResponse":{
- "type":"structure",
- "members":{
- "SkillSummaries":{
- "shape":"SkillSummaryList",
- "documentation":"The list of enabled skills requested. Required.
"
- },
- "NextToken":{
- "shape":"NextToken",
- "documentation":"The token returned to indicate that there is more data available.
"
- }
- }
- },
- "ListTagsRequest":{
- "type":"structure",
- "required":["Arn"],
- "members":{
- "Arn":{
- "shape":"Arn",
- "documentation":"The ARN of the specified resource for which to list tags.
"
- },
- "NextToken":{
- "shape":"NextToken",
- "documentation":"An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
"
- },
- "MaxResults":{
- "shape":"MaxResults",
- "documentation":"The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
"
- }
- }
- },
- "ListTagsResponse":{
- "type":"structure",
- "members":{
- "Tags":{
- "shape":"TagList",
- "documentation":"The tags requested for the specified resource.
"
- },
- "NextToken":{
- "shape":"NextToken",
- "documentation":"The token returned to indicate that there is more data available.
"
- }
- }
- },
- "MacAddress":{"type":"string"},
- "MaxResults":{
- "type":"integer",
- "max":50,
- "min":1
- },
- "MaxVolumeLimit":{"type":"integer"},
- "NameInUseException":{
- "type":"structure",
- "members":{
- "Message":{"shape":"ErrorMessage"}
- },
- "documentation":"The name sent in the request is already in use. HTTP Status Code: 400
",
- "exception":true
- },
- "NextToken":{
- "type":"string",
- "max":1000,
- "min":1
- },
- "NotFoundException":{
- "type":"structure",
- "members":{
- "Message":{"shape":"ErrorMessage"}
- },
- "documentation":"The resource is not found. HTTP Status Code: 400
",
- "exception":true
- },
- "Profile":{
- "type":"structure",
- "members":{
- "ProfileArn":{
- "shape":"Arn",
- "documentation":"The ARN of a room profile.
"
- },
- "ProfileName":{
- "shape":"ProfileName",
- "documentation":"The name of a room profile.
"
- },
- "Address":{
- "shape":"Address",
- "documentation":"The address of a room profile.
"
- },
- "Timezone":{
- "shape":"Timezone",
- "documentation":"The time zone of a room profile.
"
- },
- "DistanceUnit":{
- "shape":"DistanceUnit",
- "documentation":"The distance unit of a room profile.
"
- },
- "TemperatureUnit":{
- "shape":"TemperatureUnit",
- "documentation":"The temperature unit of a room profile.
"
- },
- "WakeWord":{
- "shape":"WakeWord",
- "documentation":"The wake word of a room profile.
"
- },
- "SetupModeDisabled":{
- "shape":"Boolean",
- "documentation":"The setup mode of a room profile.
"
- },
- "MaxVolumeLimit":{
- "shape":"MaxVolumeLimit",
- "documentation":"The max volume limit of a room profile.
"
- },
- "PSTNEnabled":{
- "shape":"Boolean",
- "documentation":"The PSTN setting of a room profile.
"
- }
- },
- "documentation":"A room profile with attributes.
"
- },
- "ProfileData":{
- "type":"structure",
- "members":{
- "ProfileArn":{
- "shape":"Arn",
- "documentation":"The ARN of a room profile.
"
- },
- "ProfileName":{
- "shape":"ProfileName",
- "documentation":"The name of a room profile.
"
- },
- "Address":{
- "shape":"Address",
- "documentation":"The address of a room profile.
"
- },
- "Timezone":{
- "shape":"Timezone",
- "documentation":"The timezone of a room profile.
"
- },
- "DistanceUnit":{
- "shape":"DistanceUnit",
- "documentation":"The distance unit of a room profile.
"
- },
- "TemperatureUnit":{
- "shape":"TemperatureUnit",
- "documentation":"The temperature unit of a room profile.
"
- },
- "WakeWord":{
- "shape":"WakeWord",
- "documentation":"The wake word of a room profile.
"
- }
- },
- "documentation":"The data of a room profile.
"
- },
- "ProfileDataList":{
- "type":"list",
- "member":{"shape":"ProfileData"}
- },
- "ProfileName":{
- "type":"string",
- "max":100,
- "min":1,
- "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*"
- },
- "ProviderCalendarId":{
- "type":"string",
- "max":100,
- "min":0
- },
- "PutRoomSkillParameterRequest":{
- "type":"structure",
- "required":[
- "SkillId",
- "RoomSkillParameter"
- ],
- "members":{
- "RoomArn":{
- "shape":"Arn",
- "documentation":"The ARN of the room associated with the room skill parameter. Required.
"
- },
- "SkillId":{
- "shape":"SkillId",
- "documentation":"The ARN of the skill associated with the room skill parameter. Required.
"
- },
- "RoomSkillParameter":{
- "shape":"RoomSkillParameter",
- "documentation":"The updated room skill parameter. Required.
"
- }
- }
- },
- "PutRoomSkillParameterResponse":{
- "type":"structure",
- "members":{
- }
- },
- "ResolveRoomRequest":{
- "type":"structure",
- "required":[
- "UserId",
- "SkillId"
- ],
- "members":{
- "UserId":{
- "shape":"UserId",
- "documentation":"The ARN of the user. Required.
"
- },
- "SkillId":{
- "shape":"SkillId",
- "documentation":"The ARN of the skill that was requested. Required.
"
- }
- }
- },
- "ResolveRoomResponse":{
- "type":"structure",
- "members":{
- "RoomArn":{
- "shape":"Arn",
- "documentation":"The ARN of the room from which the skill request was invoked.
"
- },
- "RoomName":{
- "shape":"RoomName",
- "documentation":"The name of the room from which the skill request was invoked.
"
- },
- "RoomSkillParameters":{
- "shape":"RoomSkillParameters",
- "documentation":"Response to get the room profile request. Required.
"
- }
- }
- },
- "ResourceInUseException":{
- "type":"structure",
- "members":{
- "Message":{"shape":"ErrorMessage"},
- "ClientRequestToken":{"shape":"ClientRequestToken"}
- },
- "documentation":"The resource in the request is already in use. HTTP Status Code: 400
",
- "exception":true
- },
- "RevokeInvitationRequest":{
- "type":"structure",
- "members":{
- "UserArn":{
- "shape":"Arn",
- "documentation":"The ARN of the user for whom to revoke an enrollment invitation. Required.
"
- },
- "EnrollmentId":{
- "shape":"EnrollmentId",
- "documentation":"The ARN of the enrollment invitation to revoke. Required.
"
- }
- }
- },
- "RevokeInvitationResponse":{
- "type":"structure",
- "members":{
- }
- },
- "Room":{
- "type":"structure",
- "members":{
- "RoomArn":{
- "shape":"Arn",
- "documentation":"The ARN of a room.
"
- },
- "RoomName":{
- "shape":"RoomName",
- "documentation":"The name of a room.
"
- },
- "Description":{
- "shape":"RoomDescription",
- "documentation":"The description of a room.
"
- },
- "ProviderCalendarId":{
- "shape":"ProviderCalendarId",
- "documentation":"The provider calendar ARN of a room.
"
- },
- "ProfileArn":{
- "shape":"Arn",
- "documentation":"The profile ARN of a room.
"
- }
- },
- "documentation":"A room with attributes.
"
- },
- "RoomData":{
- "type":"structure",
- "members":{
- "RoomArn":{
- "shape":"Arn",
- "documentation":"The ARN of a room.
"
- },
- "RoomName":{
- "shape":"RoomName",
- "documentation":"The name of a room.
"
- },
- "Description":{
- "shape":"RoomDescription",
- "documentation":"The description of a room.
"
- },
- "ProviderCalendarId":{
- "shape":"ProviderCalendarId",
- "documentation":"The provider calendar ARN of a room.
"
- },
- "ProfileArn":{
- "shape":"Arn",
- "documentation":"The profile ARN of a room.
"
- },
- "ProfileName":{
- "shape":"ProfileName",
- "documentation":"The profile name of a room.
"
- }
- },
- "documentation":"The data of a room.
"
- },
- "RoomDataList":{
- "type":"list",
- "member":{"shape":"RoomData"}
- },
- "RoomDescription":{
- "type":"string",
- "max":200,
- "min":1,
- "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*"
- },
- "RoomName":{
- "type":"string",
- "max":100,
- "min":1,
- "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*"
- },
- "RoomSkillParameter":{
- "type":"structure",
- "required":[
- "ParameterKey",
- "ParameterValue"
- ],
- "members":{
- "ParameterKey":{
- "shape":"RoomSkillParameterKey",
- "documentation":"The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.
"
- },
- "ParameterValue":{
- "shape":"RoomSkillParameterValue",
- "documentation":"The parameter value of a room skill parameter.
"
- }
- },
- "documentation":"A skill parameter associated with a room.
"
- },
- "RoomSkillParameterKey":{
- "type":"string",
- "max":256,
- "min":1
- },
- "RoomSkillParameterValue":{
- "type":"string",
- "max":512,
- "min":1
- },
- "RoomSkillParameters":{
- "type":"list",
- "member":{"shape":"RoomSkillParameter"}
- },
- "SearchAddressBooksRequest":{
- "type":"structure",
- "members":{
- "Filters":{
- "shape":"FilterList",
- "documentation":"The filters to use to list a specified set of address books. The supported filter key is AddressBookName.
"
- },
- "SortCriteria":{
- "shape":"SortList",
- "documentation":"The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.
"
- },
- "NextToken":{
- "shape":"NextToken",
- "documentation":"An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.
"
- },
- "MaxResults":{
- "shape":"MaxResults",
- "documentation":"The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
"
- }
- }
- },
- "SearchAddressBooksResponse":{
- "type":"structure",
- "members":{
- "AddressBooks":{
- "shape":"AddressBookDataList",
- "documentation":"The address books that meet the specified set of filter criteria, in sort order.
"
- },
- "NextToken":{
- "shape":"NextToken",
- "documentation":"The token returned to indicate that there is more data available.
"
- },
- "TotalCount":{
- "shape":"TotalCount",
- "documentation":"The total number of address books returned.
"
- }
- }
- },
- "SearchContactsRequest":{
- "type":"structure",
- "members":{
- "Filters":{
- "shape":"FilterList",
- "documentation":"The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.
"
- },
- "SortCriteria":{
- "shape":"SortList",
- "documentation":"The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.
"
- },
- "NextToken":{
- "shape":"NextToken",
- "documentation":"An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.
"
- },
- "MaxResults":{
- "shape":"MaxResults",
- "documentation":"The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
"
- }
- }
- },
- "SearchContactsResponse":{
- "type":"structure",
- "members":{
- "Contacts":{
- "shape":"ContactDataList",
- "documentation":"The contacts that meet the specified set of filter criteria, in sort order.
"
- },
- "NextToken":{
- "shape":"NextToken",
- "documentation":"The token returned to indicate that there is more data available.
"
- },
- "TotalCount":{
- "shape":"TotalCount",
- "documentation":"The total number of contacts returned.
"
- }
- }
- },
- "SearchDevicesRequest":{
- "type":"structure",
- "members":{
- "NextToken":{
- "shape":"NextToken",
- "documentation":"An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
"
- },
- "MaxResults":{
- "shape":"MaxResults",
- "documentation":"The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
"
- },
- "Filters":{
- "shape":"FilterList",
- "documentation":"The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, and ConnectionStatus (ONLINE and OFFLINE).
"
- },
- "SortCriteria":{
- "shape":"SortList",
- "documentation":"The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, and ConnectionStatus.
"
- }
- }
- },
- "SearchDevicesResponse":{
- "type":"structure",
- "members":{
- "Devices":{
- "shape":"DeviceDataList",
- "documentation":"The devices that meet the specified set of filter criteria, in sort order.
"
- },
- "NextToken":{
- "shape":"NextToken",
- "documentation":"The token returned to indicate that there is more data available.
"
- },
- "TotalCount":{
- "shape":"TotalCount",
- "documentation":"The total number of devices returned.
"
- }
- }
- },
- "SearchProfilesRequest":{
- "type":"structure",
- "members":{
- "NextToken":{
- "shape":"NextToken",
- "documentation":"An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
"
- },
- "MaxResults":{
- "shape":"MaxResults",
- "documentation":"The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
"
- },
- "Filters":{
- "shape":"FilterList",
- "documentation":"The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.
"
- },
- "SortCriteria":{
- "shape":"SortList",
- "documentation":"The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.
"
- }
- }
- },
- "SearchProfilesResponse":{
- "type":"structure",
- "members":{
- "Profiles":{
- "shape":"ProfileDataList",
- "documentation":"The profiles that meet the specified set of filter criteria, in sort order.
"
- },
- "NextToken":{
- "shape":"NextToken",
- "documentation":"The token returned to indicate that there is more data available.
"
- },
- "TotalCount":{
- "shape":"TotalCount",
- "documentation":"The total number of room profiles returned.
"
- }
- }
- },
- "SearchRoomsRequest":{
- "type":"structure",
- "members":{
- "NextToken":{
- "shape":"NextToken",
- "documentation":"An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
"
- },
- "MaxResults":{
- "shape":"MaxResults",
- "documentation":"The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
"
- },
- "Filters":{
- "shape":"FilterList",
- "documentation":"The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
"
- },
- "SortCriteria":{
- "shape":"SortList",
- "documentation":"The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.
"
- }
- }
- },
- "SearchRoomsResponse":{
- "type":"structure",
- "members":{
- "Rooms":{
- "shape":"RoomDataList",
- "documentation":"The rooms that meet the specified set of filter criteria, in sort order.
"
- },
- "NextToken":{
- "shape":"NextToken",
- "documentation":"The token returned to indicate that there is more data available.
"
- },
- "TotalCount":{
- "shape":"TotalCount",
- "documentation":"The total number of rooms returned.
"
- }
- }
- },
- "SearchSkillGroupsRequest":{
- "type":"structure",
- "members":{
- "NextToken":{
- "shape":"NextToken",
- "documentation":"An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.
"
- },
- "MaxResults":{
- "shape":"MaxResults",
- "documentation":"The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
"
- },
- "Filters":{
- "shape":"FilterList",
- "documentation":"The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.
"
- },
- "SortCriteria":{
- "shape":"SortList",
- "documentation":"The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.
"
- }
- }
- },
- "SearchSkillGroupsResponse":{
- "type":"structure",
- "members":{
- "SkillGroups":{
- "shape":"SkillGroupDataList",
- "documentation":"The skill groups that meet the filter criteria, in sort order.
"
- },
- "NextToken":{
- "shape":"NextToken",
- "documentation":"The token returned to indicate that there is more data available.
"
- },
- "TotalCount":{
- "shape":"TotalCount",
- "documentation":"The total number of skill groups returned.
"
- }
- }
- },
- "SearchUsersRequest":{
- "type":"structure",
- "members":{
- "NextToken":{
- "shape":"NextToken",
- "documentation":"An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.
"
- },
- "MaxResults":{
- "shape":"MaxResults",
- "documentation":"The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.
"
- },
- "Filters":{
- "shape":"FilterList",
- "documentation":"The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
"
- },
- "SortCriteria":{
- "shape":"SortList",
- "documentation":"The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
"
- }
- }
- },
- "SearchUsersResponse":{
- "type":"structure",
- "members":{
- "Users":{
- "shape":"UserDataList",
- "documentation":"The users that meet the specified set of filter criteria, in sort order.
"
- },
- "NextToken":{
- "shape":"NextToken",
- "documentation":"The token returned to indicate that there is more data available.
"
- },
- "TotalCount":{
- "shape":"TotalCount",
- "documentation":"The total number of users returned.
"
- }
- }
- },
- "SendInvitationRequest":{
- "type":"structure",
- "members":{
- "UserArn":{
- "shape":"Arn",
- "documentation":"The ARN of the user to whom to send an invitation. Required.
"
- }
- }
- },
- "SendInvitationResponse":{
- "type":"structure",
- "members":{
- }
- },
- "SkillGroup":{
- "type":"structure",
- "members":{
- "SkillGroupArn":{
- "shape":"Arn",
- "documentation":"The ARN of a skill group.
"
- },
- "SkillGroupName":{
- "shape":"SkillGroupName",
- "documentation":"The name of a skill group.
"
- },
- "Description":{
- "shape":"SkillGroupDescription",
- "documentation":"The description of a skill group.
"
- }
- },
- "documentation":"A skill group with attributes.
"
- },
- "SkillGroupData":{
- "type":"structure",
- "members":{
- "SkillGroupArn":{
- "shape":"Arn",
- "documentation":"The skill group ARN of a skill group.
"
- },
- "SkillGroupName":{
- "shape":"SkillGroupName",
- "documentation":"The skill group name of a skill group.
"
- },
- "Description":{
- "shape":"SkillGroupDescription",
- "documentation":"The description of a skill group.
"
- }
- },
- "documentation":"The attributes of a skill group.
"
- },
- "SkillGroupDataList":{
- "type":"list",
- "member":{"shape":"SkillGroupData"}
- },
- "SkillGroupDescription":{
- "type":"string",
- "max":200,
- "min":1,
- "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*"
- },
- "SkillGroupName":{
- "type":"string",
- "max":100,
- "min":1,
- "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*"
- },
- "SkillId":{
- "type":"string",
- "pattern":"(^amzn1\\.ask\\.skill\\.[0-9a-f\\-]{1,200})|(^amzn1\\.echo-sdk-ams\\.app\\.[0-9a-f\\-]{1,200})"
- },
- "SkillListMaxResults":{
- "type":"integer",
- "max":10,
- "min":1
- },
- "SkillName":{
- "type":"string",
- "max":100,
- "min":1,
- "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*"
- },
- "SkillSummary":{
- "type":"structure",
- "members":{
- "SkillId":{
- "shape":"SkillId",
- "documentation":"The ARN of the skill summary.
"
- },
- "SkillName":{
- "shape":"SkillName",
- "documentation":"The name of the skill.
"
- },
- "SupportsLinking":{
- "shape":"boolean",
- "documentation":"Linking support for a skill.
"
- }
- },
- "documentation":"The summary of skills.
"
- },
- "SkillSummaryList":{
- "type":"list",
- "member":{"shape":"SkillSummary"}
- },
- "SoftwareVersion":{"type":"string"},
- "Sort":{
- "type":"structure",
- "required":[
- "Key",
- "Value"
- ],
- "members":{
- "Key":{
- "shape":"SortKey",
- "documentation":"The sort key of a sort object.
"
- },
- "Value":{
- "shape":"SortValue",
- "documentation":"The sort value of a sort object.
"
- }
- },
- "documentation":"An object representing a sort criteria.
"
- },
- "SortKey":{
- "type":"string",
- "max":500,
- "min":1
- },
- "SortList":{
- "type":"list",
- "member":{"shape":"Sort"},
- "max":25
- },
- "SortValue":{
- "type":"string",
- "enum":[
- "ASC",
- "DESC"
- ]
- },
- "StartDeviceSyncRequest":{
- "type":"structure",
- "required":["Features"],
- "members":{
- "RoomArn":{
- "shape":"Arn",
- "documentation":"The ARN of the room with which the device to sync is associated. Required.
"
- },
- "DeviceArn":{
- "shape":"Arn",
- "documentation":"The ARN of the device to sync. Required.
"
- },
- "Features":{
- "shape":"Features",
- "documentation":"Request structure to start the device sync. Required.
"
- }
- }
- },
- "StartDeviceSyncResponse":{
- "type":"structure",
- "members":{
- }
- },
- "Tag":{
- "type":"structure",
- "members":{
- "Key":{
- "shape":"TagKey",
- "documentation":"The key of a tag. Tag keys are case-sensitive.
"
- },
- "Value":{
- "shape":"TagValue",
- "documentation":"The value of a tag. Tag values are case-sensitive and can be null.
"
- }
- },
- "documentation":"A key-value pair that can be associated with a resource.
"
- },
- "TagKey":{
- "type":"string",
- "max":128,
- "min":1,
- "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
- },
- "TagKeyList":{
- "type":"list",
- "member":{"shape":"TagKey"}
- },
- "TagList":{
- "type":"list",
- "member":{"shape":"Tag"}
- },
- "TagResourceRequest":{
- "type":"structure",
- "required":[
- "Arn",
- "Tags"
- ],
- "members":{
- "Arn":{
- "shape":"Arn",
- "documentation":"The ARN of the resource to which to add metadata tags. Required.
"
- },
- "Tags":{
- "shape":"TagList",
- "documentation":"The tags to be added to the specified resource. Do not provide system tags. Required.
"
- }
- }
- },
- "TagResourceResponse":{
- "type":"structure",
- "members":{
- }
- },
- "TagValue":{
- "type":"string",
- "max":256,
- "min":0,
- "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
- },
- "TemperatureUnit":{
- "type":"string",
- "enum":[
- "FAHRENHEIT",
- "CELSIUS"
- ]
- },
- "Timestamp":{"type":"timestamp"},
- "Timezone":{
- "type":"string",
- "max":100,
- "min":1
- },
- "TotalCount":{"type":"integer"},
- "UntagResourceRequest":{
- "type":"structure",
- "required":[
- "Arn",
- "TagKeys"
- ],
- "members":{
- "Arn":{
- "shape":"Arn",
- "documentation":"The ARN of the resource from which to remove metadata tags. Required.
"
- },
- "TagKeys":{
- "shape":"TagKeyList",
- "documentation":"The tags to be removed from the specified resource. Do not provide system tags. Required.
"
- }
- }
- },
- "UntagResourceResponse":{
- "type":"structure",
- "members":{
- }
- },
- "UpdateAddressBookRequest":{
- "type":"structure",
- "required":["AddressBookArn"],
- "members":{
- "AddressBookArn":{
- "shape":"Arn",
- "documentation":"The ARN of the room to update.
"
- },
- "Name":{
- "shape":"AddressBookName",
- "documentation":"The updated name of the room.
"
- },
- "Description":{
- "shape":"AddressBookDescription",
- "documentation":"The updated description of the room.
"
- }
- }
- },
- "UpdateAddressBookResponse":{
- "type":"structure",
- "members":{
- }
- },
- "UpdateContactRequest":{
- "type":"structure",
- "required":["ContactArn"],
- "members":{
- "ContactArn":{
- "shape":"Arn",
- "documentation":"The ARN of the contact to update.
"
- },
- "DisplayName":{
- "shape":"ContactName",
- "documentation":"The updated display name of the contact.
"
- },
- "FirstName":{
- "shape":"ContactName",
- "documentation":"The updated first name of the contact.
"
- },
- "LastName":{
- "shape":"ContactName",
- "documentation":"The updated last name of the contact.
"
- },
- "PhoneNumber":{
- "shape":"E164PhoneNumber",
- "documentation":"The updated phone number of the contact.
"
- }
- }
- },
- "UpdateContactResponse":{
- "type":"structure",
- "members":{
- }
- },
- "UpdateDeviceRequest":{
- "type":"structure",
- "members":{
- "DeviceArn":{
- "shape":"Arn",
- "documentation":"The ARN of the device to update. Required.
"
- },
- "DeviceName":{
- "shape":"DeviceName",
- "documentation":"The updated device name. Required.
"
- }
- }
- },
- "UpdateDeviceResponse":{
- "type":"structure",
- "members":{
- }
- },
- "UpdateProfileRequest":{
- "type":"structure",
- "members":{
- "ProfileArn":{
- "shape":"Arn",
- "documentation":"The ARN of the room profile to update. Required.
"
- },
- "ProfileName":{
- "shape":"ProfileName",
- "documentation":"The updated name for the room profile.
"
- },
- "Timezone":{
- "shape":"Timezone",
- "documentation":"The updated timezone for the room profile.
"
- },
- "Address":{
- "shape":"Address",
- "documentation":"The updated address for the room profile.
"
- },
- "DistanceUnit":{
- "shape":"DistanceUnit",
- "documentation":"The updated distance unit for the room profile.
"
- },
- "TemperatureUnit":{
- "shape":"TemperatureUnit",
- "documentation":"The updated temperature unit for the room profile.
"
- },
- "WakeWord":{
- "shape":"WakeWord",
- "documentation":"The updated wake word for the room profile.
"
- },
- "SetupModeDisabled":{
- "shape":"Boolean",
- "documentation":"Whether the setup mode of the profile is enabled.
"
- },
- "MaxVolumeLimit":{
- "shape":"MaxVolumeLimit",
- "documentation":"The updated maximum volume limit for the room profile.
"
- },
- "PSTNEnabled":{
- "shape":"Boolean",
- "documentation":"Whether the PSTN setting of the room profile is enabled.
"
- }
- }
- },
- "UpdateProfileResponse":{
- "type":"structure",
- "members":{
- }
- },
- "UpdateRoomRequest":{
- "type":"structure",
- "members":{
- "RoomArn":{
- "shape":"Arn",
- "documentation":"The ARN of the room to update.
"
- },
- "RoomName":{
- "shape":"RoomName",
- "documentation":"The updated name for the room.
"
- },
- "Description":{
- "shape":"RoomDescription",
- "documentation":"The updated description for the room.
"
- },
- "ProviderCalendarId":{
- "shape":"ProviderCalendarId",
- "documentation":"The updated provider calendar ARN for the room.
"
- },
- "ProfileArn":{
- "shape":"Arn",
- "documentation":"The updated profile ARN for the room.
"
- }
- }
- },
- "UpdateRoomResponse":{
- "type":"structure",
- "members":{
- }
- },
- "UpdateSkillGroupRequest":{
- "type":"structure",
- "members":{
- "SkillGroupArn":{
- "shape":"Arn",
- "documentation":"The ARN of the skill group to update.
"
- },
- "SkillGroupName":{
- "shape":"SkillGroupName",
- "documentation":"The updated name for the skill group.
"
- },
- "Description":{
- "shape":"SkillGroupDescription",
- "documentation":"The updated description for the skill group.
"
- }
- }
- },
- "UpdateSkillGroupResponse":{
- "type":"structure",
- "members":{
- }
- },
- "UserData":{
- "type":"structure",
- "members":{
- "UserArn":{
- "shape":"Arn",
- "documentation":"The ARN of a user.
"
- },
- "FirstName":{
- "shape":"user_FirstName",
- "documentation":"The first name of a user.
"
- },
- "LastName":{
- "shape":"user_LastName",
- "documentation":"The last name of a user.
"
- },
- "Email":{
- "shape":"Email",
- "documentation":"The email of a user.
"
- },
- "EnrollmentStatus":{
- "shape":"EnrollmentStatus",
- "documentation":"The enrollment status of a user.
"
- },
- "EnrollmentId":{
- "shape":"EnrollmentId",
- "documentation":"The enrollment ARN of a user.
"
- }
- },
- "documentation":"Information related to a user.
"
- },
- "UserDataList":{
- "type":"list",
- "member":{"shape":"UserData"}
- },
- "UserId":{
- "type":"string",
- "pattern":"amzn1\\.[A-Za-z0-9+-\\/=.]{1,300}"
- },
- "WakeWord":{
- "type":"string",
- "enum":[
- "ALEXA",
- "AMAZON",
- "ECHO",
- "COMPUTER"
- ]
- },
- "boolean":{"type":"boolean"},
- "user_FirstName":{
- "type":"string",
- "max":30,
- "min":0,
- "pattern":"([A-Za-z\\-' 0-9._]|\\p{IsLetter})*"
- },
- "user_LastName":{
- "type":"string",
- "max":30,
- "min":0,
- "pattern":"([A-Za-z\\-' 0-9._]|\\p{IsLetter})*"
- },
- "user_UserId":{
- "type":"string",
- "max":128,
- "min":1,
- "pattern":"[a-zA-Z0-9@_+.-]*"
- }
- },
- "documentation":"Alexa for Business makes it easy for you to use Alexa in your organization. Alexa for Business gives you the tools you need for managing Alexa devices, enroll your users, and assign skills, at scale. You can build your own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations. You can make also these available as private skills for your organization. Alexa for Business makes it easy to voice-enable your products and services, providing context-aware voice experiences for your customers.
"
-}
diff --git a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/apigateway/2015-07-09/examples-1.json b/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/apigateway/2015-07-09/examples-1.json
deleted file mode 100644
index 0ea7e3b0..00000000
--- a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/apigateway/2015-07-09/examples-1.json
+++ /dev/null
@@ -1,5 +0,0 @@
-{
- "version": "1.0",
- "examples": {
- }
-}
diff --git a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/apigateway/2015-07-09/paginators-1.json b/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/apigateway/2015-07-09/paginators-1.json
deleted file mode 100644
index c7a44f17..00000000
--- a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/apigateway/2015-07-09/paginators-1.json
+++ /dev/null
@@ -1,76 +0,0 @@
-{
- "pagination": {
- "GetApiKeys": {
- "input_token": "position",
- "output_token": "position",
- "limit_key": "limit",
- "result_key": "items"
- },
- "GetBasePathMappings": {
- "input_token": "position",
- "output_token": "position",
- "limit_key": "limit",
- "result_key": "items"
- },
- "GetClientCertificates": {
- "input_token": "position",
- "output_token": "position",
- "limit_key": "limit",
- "result_key": "items"
- },
- "GetDeployments": {
- "input_token": "position",
- "output_token": "position",
- "limit_key": "limit",
- "result_key": "items"
- },
- "GetDomainNames": {
- "input_token": "position",
- "output_token": "position",
- "limit_key": "limit",
- "result_key": "items"
- },
- "GetModels": {
- "input_token": "position",
- "output_token": "position",
- "limit_key": "limit",
- "result_key": "items"
- },
- "GetResources": {
- "input_token": "position",
- "output_token": "position",
- "limit_key": "limit",
- "result_key": "items"
- },
- "GetRestApis": {
- "input_token": "position",
- "output_token": "position",
- "limit_key": "limit",
- "result_key": "items"
- },
- "GetUsage": {
- "input_token": "position",
- "output_token": "position",
- "limit_key": "limit",
- "result_key": "items"
- },
- "GetUsagePlans": {
- "input_token": "position",
- "output_token": "position",
- "limit_key": "limit",
- "result_key": "items"
- },
- "GetUsagePlanKeys": {
- "input_token": "position",
- "output_token": "position",
- "limit_key": "limit",
- "result_key": "items"
- },
- "GetVpcLinks": {
- "input_token": "position",
- "limit_key": "limit",
- "output_token": "position",
- "result_key": "items"
- }
- }
-}
diff --git a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/apigateway/2015-07-09/service-2.json b/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/apigateway/2015-07-09/service-2.json
deleted file mode 100644
index cc0dc9f6..00000000
--- a/.eggs/botocore-1.10.75-py2.7.egg/botocore/data/apigateway/2015-07-09/service-2.json
+++ /dev/null
@@ -1,7026 +0,0 @@
-{
- "version":"2.0",
- "metadata":{
- "apiVersion":"2015-07-09",
- "endpointPrefix":"apigateway",
- "protocol":"rest-json",
- "serviceFullName":"Amazon API Gateway",
- "serviceId":"API Gateway",
- "signatureVersion":"v4",
- "uid":"apigateway-2015-07-09"
- },
- "operations":{
- "CreateApiKey":{
- "name":"CreateApiKey",
- "http":{
- "method":"POST",
- "requestUri":"/apikeys",
- "responseCode":201
- },
- "input":{"shape":"CreateApiKeyRequest"},
- "output":{"shape":"ApiKey"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"LimitExceededException"},
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"}
- ],
- "documentation":"Create an ApiKey resource.
"
- },
- "CreateAuthorizer":{
- "name":"CreateAuthorizer",
- "http":{
- "method":"POST",
- "requestUri":"/restapis/{restapi_id}/authorizers",
- "responseCode":201
- },
- "input":{"shape":"CreateAuthorizerRequest"},
- "output":{"shape":"Authorizer"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"LimitExceededException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Adds a new Authorizer resource to an existing RestApi resource.
"
- },
- "CreateBasePathMapping":{
- "name":"CreateBasePathMapping",
- "http":{
- "method":"POST",
- "requestUri":"/domainnames/{domain_name}/basepathmappings",
- "responseCode":201
- },
- "input":{"shape":"CreateBasePathMappingRequest"},
- "output":{"shape":"BasePathMapping"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"ConflictException"},
- {"shape":"BadRequestException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Creates a new BasePathMapping resource.
"
- },
- "CreateDeployment":{
- "name":"CreateDeployment",
- "http":{
- "method":"POST",
- "requestUri":"/restapis/{restapi_id}/deployments",
- "responseCode":201
- },
- "input":{"shape":"CreateDeploymentRequest"},
- "output":{"shape":"Deployment"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"BadRequestException"},
- {"shape":"NotFoundException"},
- {"shape":"ConflictException"},
- {"shape":"LimitExceededException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"ServiceUnavailableException"}
- ],
- "documentation":"Creates a Deployment resource, which makes a specified RestApi callable over the internet.
"
- },
- "CreateDocumentationPart":{
- "name":"CreateDocumentationPart",
- "http":{
- "method":"POST",
- "requestUri":"/restapis/{restapi_id}/documentation/parts",
- "responseCode":201
- },
- "input":{"shape":"CreateDocumentationPartRequest"},
- "output":{"shape":"DocumentationPart"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"LimitExceededException"},
- {"shape":"TooManyRequestsException"}
- ]
- },
- "CreateDocumentationVersion":{
- "name":"CreateDocumentationVersion",
- "http":{
- "method":"POST",
- "requestUri":"/restapis/{restapi_id}/documentation/versions",
- "responseCode":201
- },
- "input":{"shape":"CreateDocumentationVersionRequest"},
- "output":{"shape":"DocumentationVersion"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"LimitExceededException"},
- {"shape":"TooManyRequestsException"}
- ]
- },
- "CreateDomainName":{
- "name":"CreateDomainName",
- "http":{
- "method":"POST",
- "requestUri":"/domainnames",
- "responseCode":201
- },
- "input":{"shape":"CreateDomainNameRequest"},
- "output":{"shape":"DomainName"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Creates a new domain name.
"
- },
- "CreateModel":{
- "name":"CreateModel",
- "http":{
- "method":"POST",
- "requestUri":"/restapis/{restapi_id}/models",
- "responseCode":201
- },
- "input":{"shape":"CreateModelRequest"},
- "output":{"shape":"Model"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"ConflictException"},
- {"shape":"LimitExceededException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Adds a new Model resource to an existing RestApi resource.
"
- },
- "CreateRequestValidator":{
- "name":"CreateRequestValidator",
- "http":{
- "method":"POST",
- "requestUri":"/restapis/{restapi_id}/requestvalidators",
- "responseCode":201
- },
- "input":{"shape":"CreateRequestValidatorRequest"},
- "output":{"shape":"RequestValidator"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"LimitExceededException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Creates a ReqeustValidator of a given RestApi.
"
- },
- "CreateResource":{
- "name":"CreateResource",
- "http":{
- "method":"POST",
- "requestUri":"/restapis/{restapi_id}/resources/{parent_id}",
- "responseCode":201
- },
- "input":{"shape":"CreateResourceRequest"},
- "output":{"shape":"Resource"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"ConflictException"},
- {"shape":"LimitExceededException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Creates a Resource resource.
"
- },
- "CreateRestApi":{
- "name":"CreateRestApi",
- "http":{
- "method":"POST",
- "requestUri":"/restapis",
- "responseCode":201
- },
- "input":{"shape":"CreateRestApiRequest"},
- "output":{"shape":"RestApi"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"LimitExceededException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Creates a new RestApi resource.
"
- },
- "CreateStage":{
- "name":"CreateStage",
- "http":{
- "method":"POST",
- "requestUri":"/restapis/{restapi_id}/stages",
- "responseCode":201
- },
- "input":{"shape":"CreateStageRequest"},
- "output":{"shape":"Stage"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"BadRequestException"},
- {"shape":"NotFoundException"},
- {"shape":"ConflictException"},
- {"shape":"LimitExceededException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Creates a new Stage resource that references a pre-existing Deployment for the API.
"
- },
- "CreateUsagePlan":{
- "name":"CreateUsagePlan",
- "http":{
- "method":"POST",
- "requestUri":"/usageplans",
- "responseCode":201
- },
- "input":{"shape":"CreateUsagePlanRequest"},
- "output":{"shape":"UsagePlan"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"LimitExceededException"},
- {"shape":"ConflictException"},
- {"shape":"NotFoundException"}
- ],
- "documentation":"Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
"
- },
- "CreateUsagePlanKey":{
- "name":"CreateUsagePlanKey",
- "http":{
- "method":"POST",
- "requestUri":"/usageplans/{usageplanId}/keys",
- "responseCode":201
- },
- "input":{"shape":"CreateUsagePlanKeyRequest"},
- "output":{"shape":"UsagePlanKey"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Creates a usage plan key for adding an existing API key to a usage plan.
"
- },
- "CreateVpcLink":{
- "name":"CreateVpcLink",
- "http":{
- "method":"POST",
- "requestUri":"/vpclinks",
- "responseCode":202
- },
- "input":{"shape":"CreateVpcLinkRequest"},
- "output":{"shape":"VpcLink"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
"
- },
- "DeleteApiKey":{
- "name":"DeleteApiKey",
- "http":{
- "method":"DELETE",
- "requestUri":"/apikeys/{api_Key}",
- "responseCode":202
- },
- "input":{"shape":"DeleteApiKeyRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Deletes the ApiKey resource.
"
- },
- "DeleteAuthorizer":{
- "name":"DeleteAuthorizer",
- "http":{
- "method":"DELETE",
- "requestUri":"/restapis/{restapi_id}/authorizers/{authorizer_id}",
- "responseCode":202
- },
- "input":{"shape":"DeleteAuthorizerRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"}
- ],
- "documentation":"Deletes an existing Authorizer resource.
"
- },
- "DeleteBasePathMapping":{
- "name":"DeleteBasePathMapping",
- "http":{
- "method":"DELETE",
- "requestUri":"/domainnames/{domain_name}/basepathmappings/{base_path}",
- "responseCode":202
- },
- "input":{"shape":"DeleteBasePathMappingRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"ConflictException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Deletes the BasePathMapping resource.
"
- },
- "DeleteClientCertificate":{
- "name":"DeleteClientCertificate",
- "http":{
- "method":"DELETE",
- "requestUri":"/clientcertificates/{clientcertificate_id}",
- "responseCode":202
- },
- "input":{"shape":"DeleteClientCertificateRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"BadRequestException"},
- {"shape":"NotFoundException"}
- ],
- "documentation":"Deletes the ClientCertificate resource.
"
- },
- "DeleteDeployment":{
- "name":"DeleteDeployment",
- "http":{
- "method":"DELETE",
- "requestUri":"/restapis/{restapi_id}/deployments/{deployment_id}",
- "responseCode":202
- },
- "input":{"shape":"DeleteDeploymentRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
"
- },
- "DeleteDocumentationPart":{
- "name":"DeleteDocumentationPart",
- "http":{
- "method":"DELETE",
- "requestUri":"/restapis/{restapi_id}/documentation/parts/{part_id}",
- "responseCode":202
- },
- "input":{"shape":"DeleteDocumentationPartRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"ConflictException"},
- {"shape":"BadRequestException"}
- ]
- },
- "DeleteDocumentationVersion":{
- "name":"DeleteDocumentationVersion",
- "http":{
- "method":"DELETE",
- "requestUri":"/restapis/{restapi_id}/documentation/versions/{doc_version}",
- "responseCode":202
- },
- "input":{"shape":"DeleteDocumentationVersionRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"},
- {"shape":"TooManyRequestsException"}
- ]
- },
- "DeleteDomainName":{
- "name":"DeleteDomainName",
- "http":{
- "method":"DELETE",
- "requestUri":"/domainnames/{domain_name}",
- "responseCode":202
- },
- "input":{"shape":"DeleteDomainNameRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Deletes the DomainName resource.
"
- },
- "DeleteGatewayResponse":{
- "name":"DeleteGatewayResponse",
- "http":{
- "method":"DELETE",
- "requestUri":"/restapis/{restapi_id}/gatewayresponses/{response_type}",
- "responseCode":202
- },
- "input":{"shape":"DeleteGatewayResponseRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"}
- ],
- "documentation":"Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
"
- },
- "DeleteIntegration":{
- "name":"DeleteIntegration",
- "http":{
- "method":"DELETE",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration",
- "responseCode":204
- },
- "input":{"shape":"DeleteIntegrationRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"ConflictException"}
- ],
- "documentation":"Represents a delete integration.
"
- },
- "DeleteIntegrationResponse":{
- "name":"DeleteIntegrationResponse",
- "http":{
- "method":"DELETE",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}",
- "responseCode":204
- },
- "input":{"shape":"DeleteIntegrationResponseRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"}
- ],
- "documentation":"Represents a delete integration response.
"
- },
- "DeleteMethod":{
- "name":"DeleteMethod",
- "http":{
- "method":"DELETE",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}",
- "responseCode":204
- },
- "input":{"shape":"DeleteMethodRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"ConflictException"}
- ],
- "documentation":"Deletes an existing Method resource.
"
- },
- "DeleteMethodResponse":{
- "name":"DeleteMethodResponse",
- "http":{
- "method":"DELETE",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}",
- "responseCode":204
- },
- "input":{"shape":"DeleteMethodResponseRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"}
- ],
- "documentation":"Deletes an existing MethodResponse resource.
"
- },
- "DeleteModel":{
- "name":"DeleteModel",
- "http":{
- "method":"DELETE",
- "requestUri":"/restapis/{restapi_id}/models/{model_name}",
- "responseCode":202
- },
- "input":{"shape":"DeleteModelRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"}
- ],
- "documentation":"Deletes a model.
"
- },
- "DeleteRequestValidator":{
- "name":"DeleteRequestValidator",
- "http":{
- "method":"DELETE",
- "requestUri":"/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}",
- "responseCode":202
- },
- "input":{"shape":"DeleteRequestValidatorRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"}
- ],
- "documentation":"Deletes a RequestValidator of a given RestApi.
"
- },
- "DeleteResource":{
- "name":"DeleteResource",
- "http":{
- "method":"DELETE",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}",
- "responseCode":202
- },
- "input":{"shape":"DeleteResourceRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Deletes a Resource resource.
"
- },
- "DeleteRestApi":{
- "name":"DeleteRestApi",
- "http":{
- "method":"DELETE",
- "requestUri":"/restapis/{restapi_id}",
- "responseCode":202
- },
- "input":{"shape":"DeleteRestApiRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"BadRequestException"}
- ],
- "documentation":"Deletes the specified API.
"
- },
- "DeleteStage":{
- "name":"DeleteStage",
- "http":{
- "method":"DELETE",
- "requestUri":"/restapis/{restapi_id}/stages/{stage_name}",
- "responseCode":202
- },
- "input":{"shape":"DeleteStageRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"BadRequestException"}
- ],
- "documentation":"Deletes a Stage resource.
"
- },
- "DeleteUsagePlan":{
- "name":"DeleteUsagePlan",
- "http":{
- "method":"DELETE",
- "requestUri":"/usageplans/{usageplanId}",
- "responseCode":202
- },
- "input":{"shape":"DeleteUsagePlanRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"BadRequestException"},
- {"shape":"NotFoundException"}
- ],
- "documentation":"Deletes a usage plan of a given plan Id.
"
- },
- "DeleteUsagePlanKey":{
- "name":"DeleteUsagePlanKey",
- "http":{
- "method":"DELETE",
- "requestUri":"/usageplans/{usageplanId}/keys/{keyId}",
- "responseCode":202
- },
- "input":{"shape":"DeleteUsagePlanKeyRequest"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Deletes a usage plan key and remove the underlying API key from the associated usage plan.
"
- },
- "DeleteVpcLink":{
- "name":"DeleteVpcLink",
- "http":{
- "method":"DELETE",
- "requestUri":"/vpclinks/{vpclink_id}",
- "responseCode":202
- },
- "input":{"shape":"DeleteVpcLinkRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"BadRequestException"}
- ],
- "documentation":"Deletes an existing VpcLink of a specified identifier.
"
- },
- "FlushStageAuthorizersCache":{
- "name":"FlushStageAuthorizersCache",
- "http":{
- "method":"DELETE",
- "requestUri":"/restapis/{restapi_id}/stages/{stage_name}/cache/authorizers",
- "responseCode":202
- },
- "input":{"shape":"FlushStageAuthorizersCacheRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Flushes all authorizer cache entries on a stage.
"
- },
- "FlushStageCache":{
- "name":"FlushStageCache",
- "http":{
- "method":"DELETE",
- "requestUri":"/restapis/{restapi_id}/stages/{stage_name}/cache/data",
- "responseCode":202
- },
- "input":{"shape":"FlushStageCacheRequest"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Flushes a stage's cache.
"
- },
- "GenerateClientCertificate":{
- "name":"GenerateClientCertificate",
- "http":{
- "method":"POST",
- "requestUri":"/clientcertificates",
- "responseCode":201
- },
- "input":{"shape":"GenerateClientCertificateRequest"},
- "output":{"shape":"ClientCertificate"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"LimitExceededException"}
- ],
- "documentation":"Generates a ClientCertificate resource.
"
- },
- "GetAccount":{
- "name":"GetAccount",
- "http":{
- "method":"GET",
- "requestUri":"/account"
- },
- "input":{"shape":"GetAccountRequest"},
- "output":{"shape":"Account"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Gets information about the current Account resource.
"
- },
- "GetApiKey":{
- "name":"GetApiKey",
- "http":{
- "method":"GET",
- "requestUri":"/apikeys/{api_Key}"
- },
- "input":{"shape":"GetApiKeyRequest"},
- "output":{"shape":"ApiKey"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Gets information about the current ApiKey resource.
"
- },
- "GetApiKeys":{
- "name":"GetApiKeys",
- "http":{
- "method":"GET",
- "requestUri":"/apikeys"
- },
- "input":{"shape":"GetApiKeysRequest"},
- "output":{"shape":"ApiKeys"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Gets information about the current ApiKeys resource.
"
- },
- "GetAuthorizer":{
- "name":"GetAuthorizer",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/authorizers/{authorizer_id}"
- },
- "input":{"shape":"GetAuthorizerRequest"},
- "output":{"shape":"Authorizer"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Describe an existing Authorizer resource.
"
- },
- "GetAuthorizers":{
- "name":"GetAuthorizers",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/authorizers"
- },
- "input":{"shape":"GetAuthorizersRequest"},
- "output":{"shape":"Authorizers"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Describe an existing Authorizers resource.
"
- },
- "GetBasePathMapping":{
- "name":"GetBasePathMapping",
- "http":{
- "method":"GET",
- "requestUri":"/domainnames/{domain_name}/basepathmappings/{base_path}"
- },
- "input":{"shape":"GetBasePathMappingRequest"},
- "output":{"shape":"BasePathMapping"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Describe a BasePathMapping resource.
"
- },
- "GetBasePathMappings":{
- "name":"GetBasePathMappings",
- "http":{
- "method":"GET",
- "requestUri":"/domainnames/{domain_name}/basepathmappings"
- },
- "input":{"shape":"GetBasePathMappingsRequest"},
- "output":{"shape":"BasePathMappings"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Represents a collection of BasePathMapping resources.
"
- },
- "GetClientCertificate":{
- "name":"GetClientCertificate",
- "http":{
- "method":"GET",
- "requestUri":"/clientcertificates/{clientcertificate_id}"
- },
- "input":{"shape":"GetClientCertificateRequest"},
- "output":{"shape":"ClientCertificate"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Gets information about the current ClientCertificate resource.
"
- },
- "GetClientCertificates":{
- "name":"GetClientCertificates",
- "http":{
- "method":"GET",
- "requestUri":"/clientcertificates"
- },
- "input":{"shape":"GetClientCertificatesRequest"},
- "output":{"shape":"ClientCertificates"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Gets a collection of ClientCertificate resources.
"
- },
- "GetDeployment":{
- "name":"GetDeployment",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/deployments/{deployment_id}"
- },
- "input":{"shape":"GetDeploymentRequest"},
- "output":{"shape":"Deployment"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"ServiceUnavailableException"}
- ],
- "documentation":"Gets information about a Deployment resource.
"
- },
- "GetDeployments":{
- "name":"GetDeployments",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/deployments"
- },
- "input":{"shape":"GetDeploymentsRequest"},
- "output":{"shape":"Deployments"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"ServiceUnavailableException"}
- ],
- "documentation":"Gets information about a Deployments collection.
"
- },
- "GetDocumentationPart":{
- "name":"GetDocumentationPart",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/documentation/parts/{part_id}"
- },
- "input":{"shape":"GetDocumentationPartRequest"},
- "output":{"shape":"DocumentationPart"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ]
- },
- "GetDocumentationParts":{
- "name":"GetDocumentationParts",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/documentation/parts"
- },
- "input":{"shape":"GetDocumentationPartsRequest"},
- "output":{"shape":"DocumentationParts"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ]
- },
- "GetDocumentationVersion":{
- "name":"GetDocumentationVersion",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/documentation/versions/{doc_version}"
- },
- "input":{"shape":"GetDocumentationVersionRequest"},
- "output":{"shape":"DocumentationVersion"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ]
- },
- "GetDocumentationVersions":{
- "name":"GetDocumentationVersions",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/documentation/versions"
- },
- "input":{"shape":"GetDocumentationVersionsRequest"},
- "output":{"shape":"DocumentationVersions"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ]
- },
- "GetDomainName":{
- "name":"GetDomainName",
- "http":{
- "method":"GET",
- "requestUri":"/domainnames/{domain_name}"
- },
- "input":{"shape":"GetDomainNameRequest"},
- "output":{"shape":"DomainName"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"ServiceUnavailableException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
"
- },
- "GetDomainNames":{
- "name":"GetDomainNames",
- "http":{
- "method":"GET",
- "requestUri":"/domainnames"
- },
- "input":{"shape":"GetDomainNamesRequest"},
- "output":{"shape":"DomainNames"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Represents a collection of DomainName resources.
"
- },
- "GetExport":{
- "name":"GetExport",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/stages/{stage_name}/exports/{export_type}",
- "responseCode":200
- },
- "input":{"shape":"GetExportRequest"},
- "output":{"shape":"ExportResponse"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Exports a deployed version of a RestApi in a specified format.
"
- },
- "GetGatewayResponse":{
- "name":"GetGatewayResponse",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/gatewayresponses/{response_type}"
- },
- "input":{"shape":"GetGatewayResponseRequest"},
- "output":{"shape":"GatewayResponse"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Gets a GatewayResponse of a specified response type on the given RestApi.
"
- },
- "GetGatewayResponses":{
- "name":"GetGatewayResponses",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/gatewayresponses"
- },
- "input":{"shape":"GetGatewayResponsesRequest"},
- "output":{"shape":"GatewayResponses"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
"
- },
- "GetIntegration":{
- "name":"GetIntegration",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration"
- },
- "input":{"shape":"GetIntegrationRequest"},
- "output":{"shape":"Integration"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Get the integration settings.
"
- },
- "GetIntegrationResponse":{
- "name":"GetIntegrationResponse",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}"
- },
- "input":{"shape":"GetIntegrationResponseRequest"},
- "output":{"shape":"IntegrationResponse"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Represents a get integration response.
"
- },
- "GetMethod":{
- "name":"GetMethod",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}"
- },
- "input":{"shape":"GetMethodRequest"},
- "output":{"shape":"Method"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Describe an existing Method resource.
"
- },
- "GetMethodResponse":{
- "name":"GetMethodResponse",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}"
- },
- "input":{"shape":"GetMethodResponseRequest"},
- "output":{"shape":"MethodResponse"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Describes a MethodResponse resource.
"
- },
- "GetModel":{
- "name":"GetModel",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/models/{model_name}"
- },
- "input":{"shape":"GetModelRequest"},
- "output":{"shape":"Model"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Describes an existing model defined for a RestApi resource.
"
- },
- "GetModelTemplate":{
- "name":"GetModelTemplate",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/models/{model_name}/default_template"
- },
- "input":{"shape":"GetModelTemplateRequest"},
- "output":{"shape":"Template"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Generates a sample mapping template that can be used to transform a payload into the structure of a model.
"
- },
- "GetModels":{
- "name":"GetModels",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/models"
- },
- "input":{"shape":"GetModelsRequest"},
- "output":{"shape":"Models"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Describes existing Models defined for a RestApi resource.
"
- },
- "GetRequestValidator":{
- "name":"GetRequestValidator",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}"
- },
- "input":{"shape":"GetRequestValidatorRequest"},
- "output":{"shape":"RequestValidator"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Gets a RequestValidator of a given RestApi.
"
- },
- "GetRequestValidators":{
- "name":"GetRequestValidators",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/requestvalidators"
- },
- "input":{"shape":"GetRequestValidatorsRequest"},
- "output":{"shape":"RequestValidators"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Gets the RequestValidators collection of a given RestApi.
"
- },
- "GetResource":{
- "name":"GetResource",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}"
- },
- "input":{"shape":"GetResourceRequest"},
- "output":{"shape":"Resource"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Lists information about a resource.
"
- },
- "GetResources":{
- "name":"GetResources",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/resources"
- },
- "input":{"shape":"GetResourcesRequest"},
- "output":{"shape":"Resources"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Lists information about a collection of Resource resources.
"
- },
- "GetRestApi":{
- "name":"GetRestApi",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}"
- },
- "input":{"shape":"GetRestApiRequest"},
- "output":{"shape":"RestApi"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Lists the RestApi resource in the collection.
"
- },
- "GetRestApis":{
- "name":"GetRestApis",
- "http":{
- "method":"GET",
- "requestUri":"/restapis"
- },
- "input":{"shape":"GetRestApisRequest"},
- "output":{"shape":"RestApis"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Lists the RestApis resources for your collection.
"
- },
- "GetSdk":{
- "name":"GetSdk",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/stages/{stage_name}/sdks/{sdk_type}",
- "responseCode":200
- },
- "input":{"shape":"GetSdkRequest"},
- "output":{"shape":"SdkResponse"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Generates a client SDK for a RestApi and Stage.
"
- },
- "GetSdkType":{
- "name":"GetSdkType",
- "http":{
- "method":"GET",
- "requestUri":"/sdktypes/{sdktype_id}"
- },
- "input":{"shape":"GetSdkTypeRequest"},
- "output":{"shape":"SdkType"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ]
- },
- "GetSdkTypes":{
- "name":"GetSdkTypes",
- "http":{
- "method":"GET",
- "requestUri":"/sdktypes"
- },
- "input":{"shape":"GetSdkTypesRequest"},
- "output":{"shape":"SdkTypes"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"TooManyRequestsException"}
- ]
- },
- "GetStage":{
- "name":"GetStage",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/stages/{stage_name}"
- },
- "input":{"shape":"GetStageRequest"},
- "output":{"shape":"Stage"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Gets information about a Stage resource.
"
- },
- "GetStages":{
- "name":"GetStages",
- "http":{
- "method":"GET",
- "requestUri":"/restapis/{restapi_id}/stages"
- },
- "input":{"shape":"GetStagesRequest"},
- "output":{"shape":"Stages"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Gets information about one or more Stage resources.
"
- },
- "GetTags":{
- "name":"GetTags",
- "http":{
- "method":"GET",
- "requestUri":"/tags/{resource_arn}"
- },
- "input":{"shape":"GetTagsRequest"},
- "output":{"shape":"Tags"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"NotFoundException"},
- {"shape":"LimitExceededException"}
- ],
- "documentation":"Gets the Tags collection for a given resource.
"
- },
- "GetUsage":{
- "name":"GetUsage",
- "http":{
- "method":"GET",
- "requestUri":"/usageplans/{usageplanId}/usage"
- },
- "input":{"shape":"GetUsageRequest"},
- "output":{"shape":"Usage"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Gets the usage data of a usage plan in a specified time interval.
"
- },
- "GetUsagePlan":{
- "name":"GetUsagePlan",
- "http":{
- "method":"GET",
- "requestUri":"/usageplans/{usageplanId}"
- },
- "input":{"shape":"GetUsagePlanRequest"},
- "output":{"shape":"UsagePlan"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Gets a usage plan of a given plan identifier.
"
- },
- "GetUsagePlanKey":{
- "name":"GetUsagePlanKey",
- "http":{
- "method":"GET",
- "requestUri":"/usageplans/{usageplanId}/keys/{keyId}",
- "responseCode":200
- },
- "input":{"shape":"GetUsagePlanKeyRequest"},
- "output":{"shape":"UsagePlanKey"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Gets a usage plan key of a given key identifier.
"
- },
- "GetUsagePlanKeys":{
- "name":"GetUsagePlanKeys",
- "http":{
- "method":"GET",
- "requestUri":"/usageplans/{usageplanId}/keys"
- },
- "input":{"shape":"GetUsagePlanKeysRequest"},
- "output":{"shape":"UsagePlanKeys"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Gets all the usage plan keys representing the API keys added to a specified usage plan.
"
- },
- "GetUsagePlans":{
- "name":"GetUsagePlans",
- "http":{
- "method":"GET",
- "requestUri":"/usageplans"
- },
- "input":{"shape":"GetUsagePlansRequest"},
- "output":{"shape":"UsagePlans"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"ConflictException"},
- {"shape":"NotFoundException"}
- ],
- "documentation":"Gets all the usage plans of the caller's account.
"
- },
- "GetVpcLink":{
- "name":"GetVpcLink",
- "http":{
- "method":"GET",
- "requestUri":"/vpclinks/{vpclink_id}"
- },
- "input":{"shape":"GetVpcLinkRequest"},
- "output":{"shape":"VpcLink"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Gets a specified VPC link under the caller's account in a region.
"
- },
- "GetVpcLinks":{
- "name":"GetVpcLinks",
- "http":{
- "method":"GET",
- "requestUri":"/vpclinks"
- },
- "input":{"shape":"GetVpcLinksRequest"},
- "output":{"shape":"VpcLinks"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Gets the VpcLinks collection under the caller's account in a selected region.
"
- },
- "ImportApiKeys":{
- "name":"ImportApiKeys",
- "http":{
- "method":"POST",
- "requestUri":"/apikeys?mode=import",
- "responseCode":201
- },
- "input":{"shape":"ImportApiKeysRequest"},
- "output":{"shape":"ApiKeyIds"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"LimitExceededException"},
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"}
- ],
- "documentation":"Import API keys from an external source, such as a CSV-formatted file.
"
- },
- "ImportDocumentationParts":{
- "name":"ImportDocumentationParts",
- "http":{
- "method":"PUT",
- "requestUri":"/restapis/{restapi_id}/documentation/parts"
- },
- "input":{"shape":"ImportDocumentationPartsRequest"},
- "output":{"shape":"DocumentationPartIds"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"LimitExceededException"},
- {"shape":"TooManyRequestsException"}
- ]
- },
- "ImportRestApi":{
- "name":"ImportRestApi",
- "http":{
- "method":"POST",
- "requestUri":"/restapis?mode=import",
- "responseCode":201
- },
- "input":{"shape":"ImportRestApiRequest"},
- "output":{"shape":"RestApi"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"LimitExceededException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"ConflictException"}
- ],
- "documentation":"A feature of the API Gateway control service for creating a new API from an external API definition file.
"
- },
- "PutGatewayResponse":{
- "name":"PutGatewayResponse",
- "http":{
- "method":"PUT",
- "requestUri":"/restapis/{restapi_id}/gatewayresponses/{response_type}",
- "responseCode":201
- },
- "input":{"shape":"PutGatewayResponseRequest"},
- "output":{"shape":"GatewayResponse"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"LimitExceededException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
"
- },
- "PutIntegration":{
- "name":"PutIntegration",
- "http":{
- "method":"PUT",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration",
- "responseCode":201
- },
- "input":{"shape":"PutIntegrationRequest"},
- "output":{"shape":"Integration"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Sets up a method's integration.
"
- },
- "PutIntegrationResponse":{
- "name":"PutIntegrationResponse",
- "http":{
- "method":"PUT",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}",
- "responseCode":201
- },
- "input":{"shape":"PutIntegrationResponseRequest"},
- "output":{"shape":"IntegrationResponse"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"LimitExceededException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"ConflictException"}
- ],
- "documentation":"Represents a put integration.
"
- },
- "PutMethod":{
- "name":"PutMethod",
- "http":{
- "method":"PUT",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}",
- "responseCode":201
- },
- "input":{"shape":"PutMethodRequest"},
- "output":{"shape":"Method"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"ConflictException"},
- {"shape":"LimitExceededException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Add a method to an existing Resource resource.
"
- },
- "PutMethodResponse":{
- "name":"PutMethodResponse",
- "http":{
- "method":"PUT",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}",
- "responseCode":201
- },
- "input":{"shape":"PutMethodResponseRequest"},
- "output":{"shape":"MethodResponse"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"ConflictException"},
- {"shape":"LimitExceededException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Adds a MethodResponse to an existing Method resource.
"
- },
- "PutRestApi":{
- "name":"PutRestApi",
- "http":{
- "method":"PUT",
- "requestUri":"/restapis/{restapi_id}"
- },
- "input":{"shape":"PutRestApiRequest"},
- "output":{"shape":"RestApi"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"LimitExceededException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"ConflictException"}
- ],
- "documentation":"A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
"
- },
- "TagResource":{
- "name":"TagResource",
- "http":{
- "method":"PUT",
- "requestUri":"/tags/{resource_arn}",
- "responseCode":204
- },
- "input":{"shape":"TagResourceRequest"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"NotFoundException"},
- {"shape":"LimitExceededException"},
- {"shape":"ConflictException"}
- ],
- "documentation":"Adds or updates a tag on a given resource.
"
- },
- "TestInvokeAuthorizer":{
- "name":"TestInvokeAuthorizer",
- "http":{
- "method":"POST",
- "requestUri":"/restapis/{restapi_id}/authorizers/{authorizer_id}"
- },
- "input":{"shape":"TestInvokeAuthorizerRequest"},
- "output":{"shape":"TestInvokeAuthorizerResponse"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
"
- },
- "TestInvokeMethod":{
- "name":"TestInvokeMethod",
- "http":{
- "method":"POST",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}"
- },
- "input":{"shape":"TestInvokeMethodRequest"},
- "output":{"shape":"TestInvokeMethodResponse"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
"
- },
- "UntagResource":{
- "name":"UntagResource",
- "http":{
- "method":"DELETE",
- "requestUri":"/tags/{resource_arn}",
- "responseCode":204
- },
- "input":{"shape":"UntagResourceRequest"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"NotFoundException"},
- {"shape":"ConflictException"}
- ],
- "documentation":"Removes a tag from a given resource.
"
- },
- "UpdateAccount":{
- "name":"UpdateAccount",
- "http":{
- "method":"PATCH",
- "requestUri":"/account"
- },
- "input":{"shape":"UpdateAccountRequest"},
- "output":{"shape":"Account"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"BadRequestException"},
- {"shape":"NotFoundException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Changes information about the current Account resource.
"
- },
- "UpdateApiKey":{
- "name":"UpdateApiKey",
- "http":{
- "method":"PATCH",
- "requestUri":"/apikeys/{api_Key}"
- },
- "input":{"shape":"UpdateApiKeyRequest"},
- "output":{"shape":"ApiKey"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"ConflictException"}
- ],
- "documentation":"Changes information about an ApiKey resource.
"
- },
- "UpdateAuthorizer":{
- "name":"UpdateAuthorizer",
- "http":{
- "method":"PATCH",
- "requestUri":"/restapis/{restapi_id}/authorizers/{authorizer_id}"
- },
- "input":{"shape":"UpdateAuthorizerRequest"},
- "output":{"shape":"Authorizer"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Updates an existing Authorizer resource.
"
- },
- "UpdateBasePathMapping":{
- "name":"UpdateBasePathMapping",
- "http":{
- "method":"PATCH",
- "requestUri":"/domainnames/{domain_name}/basepathmappings/{base_path}"
- },
- "input":{"shape":"UpdateBasePathMappingRequest"},
- "output":{"shape":"BasePathMapping"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"ConflictException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Changes information about the BasePathMapping resource.
"
- },
- "UpdateClientCertificate":{
- "name":"UpdateClientCertificate",
- "http":{
- "method":"PATCH",
- "requestUri":"/clientcertificates/{clientcertificate_id}"
- },
- "input":{"shape":"UpdateClientCertificateRequest"},
- "output":{"shape":"ClientCertificate"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"BadRequestException"},
- {"shape":"NotFoundException"}
- ],
- "documentation":"Changes information about an ClientCertificate resource.
"
- },
- "UpdateDeployment":{
- "name":"UpdateDeployment",
- "http":{
- "method":"PATCH",
- "requestUri":"/restapis/{restapi_id}/deployments/{deployment_id}"
- },
- "input":{"shape":"UpdateDeploymentRequest"},
- "output":{"shape":"Deployment"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"ServiceUnavailableException"}
- ],
- "documentation":"Changes information about a Deployment resource.
"
- },
- "UpdateDocumentationPart":{
- "name":"UpdateDocumentationPart",
- "http":{
- "method":"PATCH",
- "requestUri":"/restapis/{restapi_id}/documentation/parts/{part_id}"
- },
- "input":{"shape":"UpdateDocumentationPartRequest"},
- "output":{"shape":"DocumentationPart"},
- "errors":[
- {"shape":"BadRequestException"},
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"ConflictException"},
- {"shape":"LimitExceededException"},
- {"shape":"TooManyRequestsException"}
- ]
- },
- "UpdateDocumentationVersion":{
- "name":"UpdateDocumentationVersion",
- "http":{
- "method":"PATCH",
- "requestUri":"/restapis/{restapi_id}/documentation/versions/{doc_version}"
- },
- "input":{"shape":"UpdateDocumentationVersionRequest"},
- "output":{"shape":"DocumentationVersion"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"ConflictException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"}
- ]
- },
- "UpdateDomainName":{
- "name":"UpdateDomainName",
- "http":{
- "method":"PATCH",
- "requestUri":"/domainnames/{domain_name}"
- },
- "input":{"shape":"UpdateDomainNameRequest"},
- "output":{"shape":"DomainName"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Changes information about the DomainName resource.
"
- },
- "UpdateGatewayResponse":{
- "name":"UpdateGatewayResponse",
- "http":{
- "method":"PATCH",
- "requestUri":"/restapis/{restapi_id}/gatewayresponses/{response_type}"
- },
- "input":{"shape":"UpdateGatewayResponseRequest"},
- "output":{"shape":"GatewayResponse"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Updates a GatewayResponse of a specified response type on the given RestApi.
"
- },
- "UpdateIntegration":{
- "name":"UpdateIntegration",
- "http":{
- "method":"PATCH",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration"
- },
- "input":{"shape":"UpdateIntegrationRequest"},
- "output":{"shape":"Integration"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"ConflictException"}
- ],
- "documentation":"Represents an update integration.
"
- },
- "UpdateIntegrationResponse":{
- "name":"UpdateIntegrationResponse",
- "http":{
- "method":"PATCH",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}"
- },
- "input":{"shape":"UpdateIntegrationResponseRequest"},
- "output":{"shape":"IntegrationResponse"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"ConflictException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Represents an update integration response.
"
- },
- "UpdateMethod":{
- "name":"UpdateMethod",
- "http":{
- "method":"PATCH",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}"
- },
- "input":{"shape":"UpdateMethodRequest"},
- "output":{"shape":"Method"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Updates an existing Method resource.
"
- },
- "UpdateMethodResponse":{
- "name":"UpdateMethodResponse",
- "http":{
- "method":"PATCH",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}",
- "responseCode":201
- },
- "input":{"shape":"UpdateMethodResponseRequest"},
- "output":{"shape":"MethodResponse"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"ConflictException"},
- {"shape":"LimitExceededException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Updates an existing MethodResponse resource.
"
- },
- "UpdateModel":{
- "name":"UpdateModel",
- "http":{
- "method":"PATCH",
- "requestUri":"/restapis/{restapi_id}/models/{model_name}"
- },
- "input":{"shape":"UpdateModelRequest"},
- "output":{"shape":"Model"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Changes information about a model.
"
- },
- "UpdateRequestValidator":{
- "name":"UpdateRequestValidator",
- "http":{
- "method":"PATCH",
- "requestUri":"/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}"
- },
- "input":{"shape":"UpdateRequestValidatorRequest"},
- "output":{"shape":"RequestValidator"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Updates a RequestValidator of a given RestApi.
"
- },
- "UpdateResource":{
- "name":"UpdateResource",
- "http":{
- "method":"PATCH",
- "requestUri":"/restapis/{restapi_id}/resources/{resource_id}"
- },
- "input":{"shape":"UpdateResourceRequest"},
- "output":{"shape":"Resource"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"ConflictException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Changes information about a Resource resource.
"
- },
- "UpdateRestApi":{
- "name":"UpdateRestApi",
- "http":{
- "method":"PATCH",
- "requestUri":"/restapis/{restapi_id}"
- },
- "input":{"shape":"UpdateRestApiRequest"},
- "output":{"shape":"RestApi"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"ConflictException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Changes information about the specified API.
"
- },
- "UpdateStage":{
- "name":"UpdateStage",
- "http":{
- "method":"PATCH",
- "requestUri":"/restapis/{restapi_id}/stages/{stage_name}"
- },
- "input":{"shape":"UpdateStageRequest"},
- "output":{"shape":"Stage"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"ConflictException"},
- {"shape":"BadRequestException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Changes information about a Stage resource.
"
- },
- "UpdateUsage":{
- "name":"UpdateUsage",
- "http":{
- "method":"PATCH",
- "requestUri":"/usageplans/{usageplanId}/keys/{keyId}/usage"
- },
- "input":{"shape":"UpdateUsageRequest"},
- "output":{"shape":"Usage"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"BadRequestException"},
- {"shape":"NotFoundException"}
- ],
- "documentation":"Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
"
- },
- "UpdateUsagePlan":{
- "name":"UpdateUsagePlan",
- "http":{
- "method":"PATCH",
- "requestUri":"/usageplans/{usageplanId}"
- },
- "input":{"shape":"UpdateUsagePlanRequest"},
- "output":{"shape":"UsagePlan"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"TooManyRequestsException"},
- {"shape":"BadRequestException"},
- {"shape":"NotFoundException"},
- {"shape":"ConflictException"}
- ],
- "documentation":"Updates a usage plan of a given plan Id.
"
- },
- "UpdateVpcLink":{
- "name":"UpdateVpcLink",
- "http":{
- "method":"PATCH",
- "requestUri":"/vpclinks/{vpclink_id}"
- },
- "input":{"shape":"UpdateVpcLinkRequest"},
- "output":{"shape":"VpcLink"},
- "errors":[
- {"shape":"UnauthorizedException"},
- {"shape":"NotFoundException"},
- {"shape":"BadRequestException"},
- {"shape":"ConflictException"},
- {"shape":"TooManyRequestsException"}
- ],
- "documentation":"Updates an existing VpcLink of a specified identifier.
"
- }
- },
- "shapes":{
- "AccessLogSettings":{
- "type":"structure",
- "members":{
- "format":{
- "shape":"String",
- "documentation":"A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
"
- },
- "destinationArn":{
- "shape":"String",
- "documentation":"The ARN of the CloudWatch Logs log group to receive access logs.
"
- }
- },
- "documentation":"Access log settings, including the access log format and access log destination ARN.
"
- },
- "Account":{
- "type":"structure",
- "members":{
- "cloudwatchRoleArn":{
- "shape":"String",
- "documentation":"The ARN of an Amazon CloudWatch role for the current Account.
"
- },
- "throttleSettings":{
- "shape":"ThrottleSettings",
- "documentation":"Specifies the API request limits configured for the current Account.
"
- },
- "features":{
- "shape":"ListOfString",
- "documentation":"A list of features supported for the account. When usage plans are enabled, the features list will include an entry of \"UsagePlans\".
"
- },
- "apiKeyVersion":{
- "shape":"String",
- "documentation":"The version of the API keys used for the account.
"
- }
- },
- "documentation":"Represents an AWS account that is associated with API Gateway.
"
- },
- "ApiKey":{
- "type":"structure",
- "members":{
- "id":{
- "shape":"String",
- "documentation":"The identifier of the API Key.
"
- },
- "value":{
- "shape":"String",
- "documentation":"The value of the API Key.
"
- },
- "name":{
- "shape":"String",
- "documentation":"The name of the API Key.
"
- },
- "customerId":{
- "shape":"String",
- "documentation":"An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
"
- },
- "description":{
- "shape":"String",
- "documentation":"The description of the API Key.
"
- },
- "enabled":{
- "shape":"Boolean",
- "documentation":"Specifies whether the API Key can be used by callers.
"
- },
- "createdDate":{
- "shape":"Timestamp",
- "documentation":"The timestamp when the API Key was created.
"
- },
- "lastUpdatedDate":{
- "shape":"Timestamp",
- "documentation":"The timestamp when the API Key was last updated.
"
- },
- "stageKeys":{
- "shape":"ListOfString",
- "documentation":"A list of Stage resources that are associated with the ApiKey resource.
"
- }
- },
- "documentation":"A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.
"
- },
- "ApiKeyIds":{
- "type":"structure",
- "members":{
- "ids":{
- "shape":"ListOfString",
- "documentation":"A list of all the ApiKey identifiers.
"
- },
- "warnings":{
- "shape":"ListOfString",
- "documentation":"A list of warning messages.
"
- }
- },
- "documentation":"The identifier of an ApiKey used in a UsagePlan.
"
- },
- "ApiKeySourceType":{
- "type":"string",
- "enum":[
- "HEADER",
- "AUTHORIZER"
- ]
- },
- "ApiKeys":{
- "type":"structure",
- "members":{
- "warnings":{
- "shape":"ListOfString",
- "documentation":"A list of warning messages logged during the import of API keys when the failOnWarnings option is set to true.
"
- },
- "position":{"shape":"String"},
- "items":{
- "shape":"ListOfApiKey",
- "documentation":"The current page of elements from this collection.
",
- "locationName":"item"
- }
- },
- "documentation":"Represents a collection of API keys as represented by an ApiKeys resource.
"
- },
- "ApiKeysFormat":{
- "type":"string",
- "enum":["csv"]
- },
- "ApiStage":{
- "type":"structure",
- "members":{
- "apiId":{
- "shape":"String",
- "documentation":"API Id of the associated API stage in a usage plan.
"
- },
- "stage":{
- "shape":"String",
- "documentation":"API stage name of the associated API stage in a usage plan.
"
- },
- "throttle":{
- "shape":"MapOfApiStageThrottleSettings",
- "documentation":"Map containing method level throttling information for API stage in a usage plan.
"
- }
- },
- "documentation":"API stage name of the associated API stage in a usage plan.
"
- },
- "Authorizer":{
- "type":"structure",
- "members":{
- "id":{
- "shape":"String",
- "documentation":"The identifier for the authorizer resource.
"
- },
- "name":{
- "shape":"String",
- "documentation":"[Required] The name of the authorizer.
"
- },
- "type":{
- "shape":"AuthorizerType",
- "documentation":"The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
"
- },
- "providerARNs":{
- "shape":"ListOfARNs",
- "documentation":"A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
"
- },
- "authType":{
- "shape":"String",
- "documentation":"Optional customer-defined field, used in Swagger imports and exports without functional impact.
"
- },
- "authorizerUri":{
- "shape":"String",
- "documentation":"Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
"
- },
- "authorizerCredentials":{
- "shape":"String",
- "documentation":"Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
"
- },
- "identitySource":{
- "shape":"String",
- "documentation":"The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
"
- },
- "identityValidationExpression":{
- "shape":"String",
- "documentation":"A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
"
- },
- "authorizerResultTtlInSeconds":{
- "shape":"NullableInteger",
- "documentation":"The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
"
- }
- },
- "documentation":"Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
"
- },
- "AuthorizerType":{
- "type":"string",
- "documentation":"The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
",
- "enum":[
- "TOKEN",
- "REQUEST",
- "COGNITO_USER_POOLS"
- ]
- },
- "Authorizers":{
- "type":"structure",
- "members":{
- "position":{"shape":"String"},
- "items":{
- "shape":"ListOfAuthorizer",
- "documentation":"The current page of elements from this collection.
",
- "locationName":"item"
- }
- },
- "documentation":"Represents a collection of Authorizer resources.
"
- },
- "BadRequestException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
- "error":{"httpStatusCode":400},
- "exception":true
- },
- "BasePathMapping":{
- "type":"structure",
- "members":{
- "basePath":{
- "shape":"String",
- "documentation":"The base path name that callers of the API must provide as part of the URL after the domain name.
"
- },
- "restApiId":{
- "shape":"String",
- "documentation":"The string identifier of the associated RestApi.
"
- },
- "stage":{
- "shape":"String",
- "documentation":"The name of the associated stage.
"
- }
- },
- "documentation":"Represents the base path that callers of the API must provide as part of the URL after the domain name.
"
- },
- "BasePathMappings":{
- "type":"structure",
- "members":{
- "position":{"shape":"String"},
- "items":{
- "shape":"ListOfBasePathMapping",
- "documentation":"The current page of elements from this collection.
",
- "locationName":"item"
- }
- },
- "documentation":"Represents a collection of BasePathMapping resources.
"
- },
- "Blob":{"type":"blob"},
- "Boolean":{"type":"boolean"},
- "CacheClusterSize":{
- "type":"string",
- "documentation":"Returns the size of the CacheCluster.
",
- "enum":[
- "0.5",
- "1.6",
- "6.1",
- "13.5",
- "28.4",
- "58.2",
- "118",
- "237"
- ]
- },
- "CacheClusterStatus":{
- "type":"string",
- "documentation":"Returns the status of the CacheCluster.
",
- "enum":[
- "CREATE_IN_PROGRESS",
- "AVAILABLE",
- "DELETE_IN_PROGRESS",
- "NOT_AVAILABLE",
- "FLUSH_IN_PROGRESS"
- ]
- },
- "CanarySettings":{
- "type":"structure",
- "members":{
- "percentTraffic":{
- "shape":"Double",
- "documentation":"The percent (0-100) of traffic diverted to a canary deployment.
"
- },
- "deploymentId":{
- "shape":"String",
- "documentation":"The ID of the canary deployment.
"
- },
- "stageVariableOverrides":{
- "shape":"MapOfStringToString",
- "documentation":"Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
"
- },
- "useStageCache":{
- "shape":"Boolean",
- "documentation":"A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
"
- }
- },
- "documentation":"Configuration settings of a canary deployment.
"
- },
- "ClientCertificate":{
- "type":"structure",
- "members":{
- "clientCertificateId":{
- "shape":"String",
- "documentation":"The identifier of the client certificate.
"
- },
- "description":{
- "shape":"String",
- "documentation":"The description of the client certificate.
"
- },
- "pemEncodedCertificate":{
- "shape":"String",
- "documentation":"The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
"
- },
- "createdDate":{
- "shape":"Timestamp",
- "documentation":"The timestamp when the client certificate was created.
"
- },
- "expirationDate":{
- "shape":"Timestamp",
- "documentation":"The timestamp when the client certificate will expire.
"
- }
- },
- "documentation":"Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
"
- },
- "ClientCertificates":{
- "type":"structure",
- "members":{
- "position":{"shape":"String"},
- "items":{
- "shape":"ListOfClientCertificate",
- "documentation":"The current page of elements from this collection.
",
- "locationName":"item"
- }
- },
- "documentation":"Represents a collection of ClientCertificate resources.
"
- },
- "ConflictException":{
- "type":"structure",
- "members":{
- "message":{"shape":"String"}
- },
- "documentation":"The request configuration has conflicts. For details, see the accompanying error message.
",
- "error":{"httpStatusCode":409},
- "exception":true
- },
- "ConnectionType":{
- "type":"string",
- "enum":[
- "INTERNET",
- "VPC_LINK"
- ]
- },
- "ContentHandlingStrategy":{
- "type":"string",
- "enum":[
- "CONVERT_TO_BINARY",
- "CONVERT_TO_TEXT"
- ]
- },
- "CreateApiKeyRequest":{
- "type":"structure",
- "members":{
- "name":{
- "shape":"String",
- "documentation":"The name of the ApiKey.
"
- },
- "description":{
- "shape":"String",
- "documentation":"The description of the ApiKey.
"
- },
- "enabled":{
- "shape":"Boolean",
- "documentation":"Specifies whether the ApiKey can be used by callers.
"
- },
- "generateDistinctId":{
- "shape":"Boolean",
- "documentation":"Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.
"
- },
- "value":{
- "shape":"String",
- "documentation":"Specifies a value of the API key.
"
- },
- "stageKeys":{
- "shape":"ListOfStageKeys",
- "documentation":"DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
"
- },
- "customerId":{
- "shape":"String",
- "documentation":"An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
"
- }
- },
- "documentation":"Request to create an ApiKey resource.
"
- },
- "CreateAuthorizerRequest":{
- "type":"structure",
- "required":[
- "restApiId",
- "name",
- "type"
- ],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "name":{
- "shape":"String",
- "documentation":"[Required] The name of the authorizer.
"
- },
- "type":{
- "shape":"AuthorizerType",
- "documentation":"[Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
"
- },
- "providerARNs":{
- "shape":"ListOfARNs",
- "documentation":"A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
"
- },
- "authType":{
- "shape":"String",
- "documentation":"Optional customer-defined field, used in Swagger imports and exports without functional impact.
"
- },
- "authorizerUri":{
- "shape":"String",
- "documentation":"Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
"
- },
- "authorizerCredentials":{
- "shape":"String",
- "documentation":"Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
"
- },
- "identitySource":{
- "shape":"String",
- "documentation":"The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
"
- },
- "identityValidationExpression":{
- "shape":"String",
- "documentation":"A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
"
- },
- "authorizerResultTtlInSeconds":{
- "shape":"NullableInteger",
- "documentation":"The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
"
- }
- },
- "documentation":"Request to add a new Authorizer to an existing RestApi resource.
"
- },
- "CreateBasePathMappingRequest":{
- "type":"structure",
- "required":[
- "domainName",
- "restApiId"
- ],
- "members":{
- "domainName":{
- "shape":"String",
- "documentation":"[Required] The domain name of the BasePathMapping resource to create.
",
- "location":"uri",
- "locationName":"domain_name"
- },
- "basePath":{
- "shape":"String",
- "documentation":"The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify a base path name after the domain name.
"
- },
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
"
- },
- "stage":{
- "shape":"String",
- "documentation":"The name of the API's stage that you want to use for this mapping. Leave this blank if you do not want callers to explicitly specify the stage name after any base path name.
"
- }
- },
- "documentation":"Requests API Gateway to create a new BasePathMapping resource.
"
- },
- "CreateDeploymentRequest":{
- "type":"structure",
- "required":["restApiId"],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "stageName":{
- "shape":"String",
- "documentation":"The name of the Stage resource for the Deployment resource to create.
"
- },
- "stageDescription":{
- "shape":"String",
- "documentation":"The description of the Stage resource for the Deployment resource to create.
"
- },
- "description":{
- "shape":"String",
- "documentation":"The description for the Deployment resource to create.
"
- },
- "cacheClusterEnabled":{
- "shape":"NullableBoolean",
- "documentation":"Enables a cache cluster for the Stage resource specified in the input.
"
- },
- "cacheClusterSize":{
- "shape":"CacheClusterSize",
- "documentation":"Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
"
- },
- "variables":{
- "shape":"MapOfStringToString",
- "documentation":"A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
"
- },
- "canarySettings":{
- "shape":"DeploymentCanarySettings",
- "documentation":"The input configuration for the canary deployment when the deployment is a canary release deployment.
"
- }
- },
- "documentation":"Requests API Gateway to create a Deployment resource.
"
- },
- "CreateDocumentationPartRequest":{
- "type":"structure",
- "required":[
- "restApiId",
- "location",
- "properties"
- ],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "location":{
- "shape":"DocumentationPartLocation",
- "documentation":"[Required] The location of the targeted API entity of the to-be-created documentation part.
"
- },
- "properties":{
- "shape":"String",
- "documentation":"[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only Swagger-compliant key-value pairs can be exported and, hence, published.
"
- }
- },
- "documentation":"Creates a new documentation part of a given API.
"
- },
- "CreateDocumentationVersionRequest":{
- "type":"structure",
- "required":[
- "restApiId",
- "documentationVersion"
- ],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "documentationVersion":{
- "shape":"String",
- "documentation":"[Required] The version identifier of the new snapshot.
"
- },
- "stageName":{
- "shape":"String",
- "documentation":"The stage name to be associated with the new documentation snapshot.
"
- },
- "description":{
- "shape":"String",
- "documentation":"A description about the new documentation snapshot.
"
- }
- },
- "documentation":"Creates a new documentation version of a given API.
"
- },
- "CreateDomainNameRequest":{
- "type":"structure",
- "required":["domainName"],
- "members":{
- "domainName":{
- "shape":"String",
- "documentation":"[Required] The name of the DomainName resource.
"
- },
- "certificateName":{
- "shape":"String",
- "documentation":"The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.
"
- },
- "certificateBody":{
- "shape":"String",
- "documentation":"[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.
"
- },
- "certificatePrivateKey":{
- "shape":"String",
- "documentation":"[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.
"
- },
- "certificateChain":{
- "shape":"String",
- "documentation":"[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.
"
- },
- "certificateArn":{
- "shape":"String",
- "documentation":"The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
"
- },
- "regionalCertificateName":{
- "shape":"String",
- "documentation":"The user-friendly name of the certificate that will be used by regional endpoint for this domain name.
"
- },
- "regionalCertificateArn":{
- "shape":"String",
- "documentation":"The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.
"
- },
- "endpointConfiguration":{
- "shape":"EndpointConfiguration",
- "documentation":"The endpoint configuration of this DomainName showing the endpoint types of the domain name.
"
- }
- },
- "documentation":"A request to create a new domain name.
"
- },
- "CreateModelRequest":{
- "type":"structure",
- "required":[
- "restApiId",
- "name",
- "contentType"
- ],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The RestApi identifier under which the Model will be created.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "name":{
- "shape":"String",
- "documentation":"[Required] The name of the model. Must be alphanumeric.
"
- },
- "description":{
- "shape":"String",
- "documentation":"The description of the model.
"
- },
- "schema":{
- "shape":"String",
- "documentation":"The schema for the model. For application/json models, this should be JSON schema draft 4 model.
"
- },
- "contentType":{
- "shape":"String",
- "documentation":"[Required] The content-type for the model.
"
- }
- },
- "documentation":"Request to add a new Model to an existing RestApi resource.
"
- },
- "CreateRequestValidatorRequest":{
- "type":"structure",
- "required":["restApiId"],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "name":{
- "shape":"String",
- "documentation":"The name of the to-be-created RequestValidator.
"
- },
- "validateRequestBody":{
- "shape":"Boolean",
- "documentation":"A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true) or not (false).
"
- },
- "validateRequestParameters":{
- "shape":"Boolean",
- "documentation":"A Boolean flag to indicate whether to validate request parameters, true, or not false.
"
- }
- },
- "documentation":"Creates a RequestValidator of a given RestApi.
"
- },
- "CreateResourceRequest":{
- "type":"structure",
- "required":[
- "restApiId",
- "parentId",
- "pathPart"
- ],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "parentId":{
- "shape":"String",
- "documentation":"[Required] The parent resource's identifier.
",
- "location":"uri",
- "locationName":"parent_id"
- },
- "pathPart":{
- "shape":"String",
- "documentation":"The last path segment for this resource.
"
- }
- },
- "documentation":"Requests API Gateway to create a Resource resource.
"
- },
- "CreateRestApiRequest":{
- "type":"structure",
- "required":["name"],
- "members":{
- "name":{
- "shape":"String",
- "documentation":"[Required] The name of the RestApi.
"
- },
- "description":{
- "shape":"String",
- "documentation":"The description of the RestApi.
"
- },
- "version":{
- "shape":"String",
- "documentation":"A version identifier for the API.
"
- },
- "cloneFrom":{
- "shape":"String",
- "documentation":"The ID of the RestApi that you want to clone from.
"
- },
- "binaryMediaTypes":{
- "shape":"ListOfString",
- "documentation":"The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
"
- },
- "minimumCompressionSize":{
- "shape":"NullableInteger",
- "documentation":"A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
"
- },
- "apiKeySource":{
- "shape":"ApiKeySourceType",
- "documentation":"The source of the API key for metering requests according to a usage plan. Valid values are:
HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
"
- },
- "endpointConfiguration":{
- "shape":"EndpointConfiguration",
- "documentation":"The endpoint configuration of this RestApi showing the endpoint types of the API.
"
- },
- "policy":{
- "shape":"String",
- "documentation":"A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration."
- }
- },
- "documentation":"The POST Request to add a new RestApi resource to your collection.
"
- },
- "CreateStageRequest":{
- "type":"structure",
- "required":[
- "restApiId",
- "stageName",
- "deploymentId"
- ],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "stageName":{
- "shape":"String",
- "documentation":"[Required] The name for the Stage resource.
"
- },
- "deploymentId":{
- "shape":"String",
- "documentation":"[Required] The identifier of the Deployment resource for the Stage resource.
"
- },
- "description":{
- "shape":"String",
- "documentation":"The description of the Stage resource.
"
- },
- "cacheClusterEnabled":{
- "shape":"Boolean",
- "documentation":"Whether cache clustering is enabled for the stage.
"
- },
- "cacheClusterSize":{
- "shape":"CacheClusterSize",
- "documentation":"The stage's cache cluster size.
"
- },
- "variables":{
- "shape":"MapOfStringToString",
- "documentation":"A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
"
- },
- "documentationVersion":{
- "shape":"String",
- "documentation":"The version of the associated API documentation.
"
- },
- "canarySettings":{
- "shape":"CanarySettings",
- "documentation":"The canary deployment settings of this stage.
"
- },
- "tags":{
- "shape":"MapOfStringToString",
- "documentation":"The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
"
- }
- },
- "documentation":"Requests API Gateway to create a Stage resource.
"
- },
- "CreateUsagePlanKeyRequest":{
- "type":"structure",
- "required":[
- "usagePlanId",
- "keyId",
- "keyType"
- ],
- "members":{
- "usagePlanId":{
- "shape":"String",
- "documentation":"[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.
",
- "location":"uri",
- "locationName":"usageplanId"
- },
- "keyId":{
- "shape":"String",
- "documentation":"[Required] The identifier of a UsagePlanKey resource for a plan customer.
"
- },
- "keyType":{
- "shape":"String",
- "documentation":"[Required] The type of a UsagePlanKey resource for a plan customer.
"
- }
- },
- "documentation":"The POST request to create a usage plan key for adding an existing API key to a usage plan.
"
- },
- "CreateUsagePlanRequest":{
- "type":"structure",
- "required":["name"],
- "members":{
- "name":{
- "shape":"String",
- "documentation":"[Required] The name of the usage plan.
"
- },
- "description":{
- "shape":"String",
- "documentation":"The description of the usage plan.
"
- },
- "apiStages":{
- "shape":"ListOfApiStage",
- "documentation":"The associated API stages of the usage plan.
"
- },
- "throttle":{
- "shape":"ThrottleSettings",
- "documentation":"The throttling limits of the usage plan.
"
- },
- "quota":{
- "shape":"QuotaSettings",
- "documentation":"The quota of the usage plan.
"
- }
- },
- "documentation":"The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.
"
- },
- "CreateVpcLinkRequest":{
- "type":"structure",
- "required":[
- "name",
- "targetArns"
- ],
- "members":{
- "name":{
- "shape":"String",
- "documentation":"[Required] The name used to label and identify the VPC link.
"
- },
- "description":{
- "shape":"String",
- "documentation":"The description of the VPC link.
"
- },
- "targetArns":{
- "shape":"ListOfString",
- "documentation":"[Required] The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.
"
- }
- },
- "documentation":"Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
"
- },
- "DeleteApiKeyRequest":{
- "type":"structure",
- "required":["apiKey"],
- "members":{
- "apiKey":{
- "shape":"String",
- "documentation":"[Required] The identifier of the ApiKey resource to be deleted.
",
- "location":"uri",
- "locationName":"api_Key"
- }
- },
- "documentation":"A request to delete the ApiKey resource.
"
- },
- "DeleteAuthorizerRequest":{
- "type":"structure",
- "required":[
- "restApiId",
- "authorizerId"
- ],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "authorizerId":{
- "shape":"String",
- "documentation":"[Required] The identifier of the Authorizer resource.
",
- "location":"uri",
- "locationName":"authorizer_id"
- }
- },
- "documentation":"Request to delete an existing Authorizer resource.
"
- },
- "DeleteBasePathMappingRequest":{
- "type":"structure",
- "required":[
- "domainName",
- "basePath"
- ],
- "members":{
- "domainName":{
- "shape":"String",
- "documentation":"[Required] The domain name of the BasePathMapping resource to delete.
",
- "location":"uri",
- "locationName":"domain_name"
- },
- "basePath":{
- "shape":"String",
- "documentation":"[Required] The base path name of the BasePathMapping resource to delete.
",
- "location":"uri",
- "locationName":"base_path"
- }
- },
- "documentation":"A request to delete the BasePathMapping resource.
"
- },
- "DeleteClientCertificateRequest":{
- "type":"structure",
- "required":["clientCertificateId"],
- "members":{
- "clientCertificateId":{
- "shape":"String",
- "documentation":"[Required] The identifier of the ClientCertificate resource to be deleted.
",
- "location":"uri",
- "locationName":"clientcertificate_id"
- }
- },
- "documentation":"A request to delete the ClientCertificate resource.
"
- },
- "DeleteDeploymentRequest":{
- "type":"structure",
- "required":[
- "restApiId",
- "deploymentId"
- ],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "deploymentId":{
- "shape":"String",
- "documentation":"[Required] The identifier of the Deployment resource to delete.
",
- "location":"uri",
- "locationName":"deployment_id"
- }
- },
- "documentation":"Requests API Gateway to delete a Deployment resource.
"
- },
- "DeleteDocumentationPartRequest":{
- "type":"structure",
- "required":[
- "restApiId",
- "documentationPartId"
- ],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "documentationPartId":{
- "shape":"String",
- "documentation":"[Required] The identifier of the to-be-deleted documentation part.
",
- "location":"uri",
- "locationName":"part_id"
- }
- },
- "documentation":"Deletes an existing documentation part of an API.
"
- },
- "DeleteDocumentationVersionRequest":{
- "type":"structure",
- "required":[
- "restApiId",
- "documentationVersion"
- ],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "documentationVersion":{
- "shape":"String",
- "documentation":"[Required] The version identifier of a to-be-deleted documentation snapshot.
",
- "location":"uri",
- "locationName":"doc_version"
- }
- },
- "documentation":"Deletes an existing documentation version of an API.
"
- },
- "DeleteDomainNameRequest":{
- "type":"structure",
- "required":["domainName"],
- "members":{
- "domainName":{
- "shape":"String",
- "documentation":"[Required] The name of the DomainName resource to be deleted.
",
- "location":"uri",
- "locationName":"domain_name"
- }
- },
- "documentation":"A request to delete the DomainName resource.
"
- },
- "DeleteGatewayResponseRequest":{
- "type":"structure",
- "required":[
- "restApiId",
- "responseType"
- ],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "responseType":{
- "shape":"GatewayResponseType",
- "documentation":"[Required]
The response type of the associated GatewayResponse. Valid values are
- ACCESS_DENIED
- API_CONFIGURATION_ERROR
- AUTHORIZER_FAILURE
- AUTHORIZER_CONFIGURATION_ERROR
- BAD_REQUEST_PARAMETERS
- BAD_REQUEST_BODY
- DEFAULT_4XX
- DEFAULT_5XX
- EXPIRED_TOKEN
- INVALID_SIGNATURE
- INTEGRATION_FAILURE
- INTEGRATION_TIMEOUT
- INVALID_API_KEY
- MISSING_AUTHENTICATION_TOKEN
- QUOTA_EXCEEDED
- REQUEST_TOO_LARGE
- RESOURCE_NOT_FOUND
- THROTTLED
- UNAUTHORIZED
- UNSUPPORTED_MEDIA_TYPE
",
- "location":"uri",
- "locationName":"response_type"
- }
- },
- "documentation":"Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
"
- },
- "DeleteIntegrationRequest":{
- "type":"structure",
- "required":[
- "restApiId",
- "resourceId",
- "httpMethod"
- ],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "resourceId":{
- "shape":"String",
- "documentation":"[Required] Specifies a delete integration request's resource identifier.
",
- "location":"uri",
- "locationName":"resource_id"
- },
- "httpMethod":{
- "shape":"String",
- "documentation":"[Required] Specifies a delete integration request's HTTP method.
",
- "location":"uri",
- "locationName":"http_method"
- }
- },
- "documentation":"Represents a delete integration request.
"
- },
- "DeleteIntegrationResponseRequest":{
- "type":"structure",
- "required":[
- "restApiId",
- "resourceId",
- "httpMethod",
- "statusCode"
- ],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "resourceId":{
- "shape":"String",
- "documentation":"[Required] Specifies a delete integration response request's resource identifier.
",
- "location":"uri",
- "locationName":"resource_id"
- },
- "httpMethod":{
- "shape":"String",
- "documentation":"[Required] Specifies a delete integration response request's HTTP method.
",
- "location":"uri",
- "locationName":"http_method"
- },
- "statusCode":{
- "shape":"StatusCode",
- "documentation":"[Required] Specifies a delete integration response request's status code.
",
- "location":"uri",
- "locationName":"status_code"
- }
- },
- "documentation":"Represents a delete integration response request.
"
- },
- "DeleteMethodRequest":{
- "type":"structure",
- "required":[
- "restApiId",
- "resourceId",
- "httpMethod"
- ],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "resourceId":{
- "shape":"String",
- "documentation":"[Required] The Resource identifier for the Method resource.
",
- "location":"uri",
- "locationName":"resource_id"
- },
- "httpMethod":{
- "shape":"String",
- "documentation":"[Required] The HTTP verb of the Method resource.
",
- "location":"uri",
- "locationName":"http_method"
- }
- },
- "documentation":"Request to delete an existing Method resource.
"
- },
- "DeleteMethodResponseRequest":{
- "type":"structure",
- "required":[
- "restApiId",
- "resourceId",
- "httpMethod",
- "statusCode"
- ],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "resourceId":{
- "shape":"String",
- "documentation":"[Required] The Resource identifier for the MethodResponse resource.
",
- "location":"uri",
- "locationName":"resource_id"
- },
- "httpMethod":{
- "shape":"String",
- "documentation":"[Required] The HTTP verb of the Method resource.
",
- "location":"uri",
- "locationName":"http_method"
- },
- "statusCode":{
- "shape":"StatusCode",
- "documentation":"[Required] The status code identifier for the MethodResponse resource.
",
- "location":"uri",
- "locationName":"status_code"
- }
- },
- "documentation":"A request to delete an existing MethodResponse resource.
"
- },
- "DeleteModelRequest":{
- "type":"structure",
- "required":[
- "restApiId",
- "modelName"
- ],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "modelName":{
- "shape":"String",
- "documentation":"[Required] The name of the model to delete.
",
- "location":"uri",
- "locationName":"model_name"
- }
- },
- "documentation":"Request to delete an existing model in an existing RestApi resource.
"
- },
- "DeleteRequestValidatorRequest":{
- "type":"structure",
- "required":[
- "restApiId",
- "requestValidatorId"
- ],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "requestValidatorId":{
- "shape":"String",
- "documentation":"[Required] The identifier of the RequestValidator to be deleted.
",
- "location":"uri",
- "locationName":"requestvalidator_id"
- }
- },
- "documentation":"Deletes a specified RequestValidator of a given RestApi.
"
- },
- "DeleteResourceRequest":{
- "type":"structure",
- "required":[
- "restApiId",
- "resourceId"
- ],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "resourceId":{
- "shape":"String",
- "documentation":"[Required] The identifier of the Resource resource.
",
- "location":"uri",
- "locationName":"resource_id"
- }
- },
- "documentation":"Request to delete a Resource.
"
- },
- "DeleteRestApiRequest":{
- "type":"structure",
- "required":["restApiId"],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- }
- },
- "documentation":"Request to delete the specified API from your collection.
"
- },
- "DeleteStageRequest":{
- "type":"structure",
- "required":[
- "restApiId",
- "stageName"
- ],
- "members":{
- "restApiId":{
- "shape":"String",
- "documentation":"[Required] The string identifier of the associated RestApi.
",
- "location":"uri",
- "locationName":"restapi_id"
- },
- "stageName":{
- "shape":"String",
- "documentation":"[Required] The name of the Stage resource to delete.
",
- "location":"uri",
- "locationName":"stage_name"
- }
- },
- "documentation":"Requests API Gateway to delete a Stage resource.
"
- },
- "DeleteUsagePlanKeyRequest":{
- "type":"structure",
- "required":[
- "usagePlanId",
- "keyId"
- ],
- "members":{
- "usagePlanId":{
- "shape":"String",
- "documentation":"[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.
",
- "location":"uri",
- "locationName":"usageplanId"
- },
- "keyId":{
- "shape":"String",
- "documentation":"[Required] The Id of the UsagePlanKey resource to be deleted.
",
- "location":"uri",
- "locationName":"keyId"
- }
- },
- "documentation":"The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.
"
- },
- "DeleteUsagePlanRequest":{
- "type":"structure",
- "required":["usagePlanId"],
- "members":{
- "usagePlanId":{
- "shape":"String",
- "documentation":"[Required] The Id of the to-be-deleted usage plan.
",
- "location":"uri",
- "locationName":"usageplanId"
- }
- },
- "documentation":"The DELETE request to delete a usage plan of a given plan Id.
"
- },
- "DeleteVpcLinkRequest":{
- "type":"structure",
- "required":["vpcLinkId"],
- "members":{
- "vpcLinkId":{
- "shape":"String",
- "documentation":"[Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
",
- "location":"uri",
- "locationName":"vpclink_id"
- }
- },
- "documentation":"Deletes an existing VpcLink of a specified identifier.
"
- },
- "Deployment":{
- "type":"structure",
- "members":{
- "id":{
- "shape":"String",
- "documentation":"The identifier for the deployment resource.
"
- },
- "description":{
- "shape":"String",
- "documentation":"The description for the deployment resource.
"
- },
- "createdDate":{
- "shape":"Timestamp",
- "documentation":"The date and time that the deployment resource was created.
"
- },
- "apiSummary":{
- "shape":"PathToMapOfMethodSnapshot",
- "documentation":"A summary of the RestApi at the date and time that the deployment resource was created.
"
- }
- },
- "documentation":"An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
"
- },
- "DeploymentCanarySettings":{
- "type":"structure",
- "members":{
- "percentTraffic":{
- "shape":"Double",
- "documentation":"The percentage (0.0-100.0) of traffic routed to the canary deployment.
"
- },
- "stageVariableOverrides":{
- "shape":"MapOfStringToString",
- "documentation":"A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.
"
- },
- "useStageCache":{
- "shape":"Boolean",
- "documentation":"A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
"
- }
- },
- "documentation":"The input configuration for a canary deployment.
"
- },
- "Deployments":{
- "type":"structure",
- "members":{
- "position":{"shape":"String"},
- "items":{
- "shape":"ListOfDeployment",
- "documentation":"The current page of elements from this collection.
",
- "locationName":"item"
- }
- },
- "documentation":"Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.
"
- },
- "DocumentationPart":{
- "type":"structure",
- "members":{
- "id":{
- "shape":"String",
- "documentation":"The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
"
- },
- "location":{
- "shape":"DocumentationPartLocation",
- "documentation":"The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
"
- },
- "properties":{
- "shape":"String",
- "documentation":"A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., \"{ \\\"description\\\": \\\"The API does ...\\\" }\". Only Swagger-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a Swagger extension of x-amazon-apigateway-documentation.
"
- }
- },
- "documentation":"A documentation part for a targeted API entity.
"
- },
- "DocumentationPartIds":{
- "type":"structure",
- "members":{
- "ids":{
- "shape":"ListOfString",
- "documentation":"A list of the returned documentation part identifiers.
"
- },
- "warnings":{
- "shape":"ListOfString",
- "documentation":"A list of warning messages reported during import of documentation parts.
"
- }
- },
- "documentation":"A collection of the imported DocumentationPart identifiers.
"
- },
- "DocumentationPartLocation":{
- "type":"structure",
- "required":["type"],
- "members":{
- "type":{
- "shape":"DocumentationPartType",
- "documentation":"[Required] The type of API entity to which the documentation content applies. Valid values are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Content inheritance does not apply to any entity of the API, AUTHORIZER, METHOD, MODEL, REQUEST_BODY, or RESOURCE type.
"
- },
- "path":{
- "shape":"String",
- "documentation":"The URL path of the target. It is a valid field for the API entity types of RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location attributes, the child entity's path attribute must match that of the parent entity as a prefix.
"
- },
- "method":{
- "shape":"String",
- "documentation":"The HTTP verb of a method. It is a valid field for the API entity types of METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly.
"
- },
- "statusCode":{
- "shape":"DocumentationPartLocationStatusCode",
- "documentation":"The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly.
"
- },
- "name":{
- "shape":"String",
- "documentation":"The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field for any other entity type.
"
- }
- },
- "documentation":"Specifies the target API entity to which the documentation applies.
"
- },
- "DocumentationPartLocationStatusCode":{
- "type":"string",
- "pattern":"^([1-5]\\d\\d|\\*|\\s*)$"
- },
- "DocumentationPartType":{
- "type":"string",
- "enum":[
- "API",
- "AUTHORIZER",
- "MODEL",
- "RESOURCE",
- "METHOD",
- "PATH_PARAMETER",
- "QUERY_PARAMETER",
- "REQUEST_HEADER",
- "REQUEST_BODY",
- "RESPONSE",
- "RESPONSE_HEADER",
- "RESPONSE_BODY"
- ]
- },
- "DocumentationParts":{
- "type":"structure",
- "members":{
- "position":{"shape":"String"},
- "items":{
- "shape":"ListOfDocumentationPart",
- "documentation":"The current page of elements from this collection.
",
- "locationName":"item"
- }
- },
- "documentation":"The collection of documentation parts of an API.